From 3e6022386813e86e6e654ea16020dc702b1fb295 Mon Sep 17 00:00:00 2001 From: joachim-gassen Date: Sat, 12 May 2018 11:48:40 +0200 Subject: [PATCH] CRAN 0.2.0 is live --- README.Rmd | 31 ++++++++++++++++++++++++++--- README.md | 29 +++++++++++++++++++++++++-- _pkgdown.yml | 2 +- cran-comments.md | 5 ++++- docs/LICENSE-text.html | 2 +- docs/articles/index.html | 2 +- docs/authors.html | 2 +- docs/index.html | 42 ++++++++++++++++++++++++++++++++------- docs/reference/index.html | 2 +- index.Rmd | 38 +++++++++++++++++++++++++++++++++-- 10 files changed, 135 insertions(+), 20 deletions(-) diff --git a/README.Rmd b/README.Rmd index c42d1ed..82f3cd7 100644 --- a/README.Rmd +++ b/README.Rmd @@ -12,7 +12,7 @@ library(knitr) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/joachim-gassen/ExPanDaR.svg?branch=master)](https://travis-ci.org/joachim-gassen/ExPanDaR) - +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ExPanDaR)](https://cran.r-project.org/package=ExPanDaR) ## Overview @@ -39,8 +39,15 @@ If you want to analyze your own panel data instead, you can also access a varian ## Installation -Finally, if you are in for the full treat and want to -test ExPanD from within R, run the following in your R session to install the ExPanDaR package and start exploring World Bank data. +If you are in for the full treat and want to test ExPanD from within R, run the following +in your R session to install the ExPanDaR package from CRAN. + +```{r, eval=FALSE} +install.packages("ExPanDaR") +library(ExPanDaR) +```` + +Or, if you want to install the current development version from Github: ```{r, eval=FALSE} if (!require("devtools")) { @@ -48,12 +55,30 @@ if (!require("devtools")) { } devtools::install_github("joachim-gassen/ExPanDaR") library(ExPanDaR) +```` + +## Basic Usage + +You can either start ExPanD without arguments so that it starts with a file upload dialog... + +```{r, eval=FALSE} +ExPanD() +```` + +...or start with one of the two example datasets that come with the package: + +```{r, eval=FALSE} ExPanD(df = worldbank, df_def = worldbank_data_def, var_def = worldbank_var_def, df_name = "World Bank Data", config_list = ExPanD_config_worldbank) + +ExPanD(df = russell_3000, + df_def = russell_3000_data_def, + df_name = "Russell 3000", + config_list = ExPanD_config_russell_3000) ```` diff --git a/README.md b/README.md index 5aebc22..1b758ba 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ExPanDaR: Explore Panel Data Interactively =============================================================================== -[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/joachim-gassen/ExPanDaR.svg?branch=master)](https://travis-ci.org/joachim-gassen/ExPanDaR) +[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/joachim-gassen/ExPanDaR.svg?branch=master)](https://travis-ci.org/joachim-gassen/ExPanDaR) [![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/ExPanDaR)](https://cran.r-project.org/package=ExPanDaR) Overview -------- @@ -27,7 +27,14 @@ If you want to analyze your own panel data instead, you can also access a varian Installation ------------ -Finally, if you are in for the full treat and want to test ExPanD from within R, run the following in your R session to install the ExPanDaR package and start exploring World Bank data. +If you are in for the full treat and want to test ExPanD from within R, run the following in your R session to install the ExPanDaR package from CRAN. + +``` r +install.packages("ExPanDaR") +library(ExPanDaR) +``` + +Or, if you want to install the current development version from Github: ``` r if (!require("devtools")) { @@ -35,12 +42,30 @@ if (!require("devtools")) { } devtools::install_github("joachim-gassen/ExPanDaR") library(ExPanDaR) +``` + +Basic Usage +----------- +You can either start ExPanD without arguments so that it starts with a file upload dialog... + +``` r +ExPanD() +``` + +...or start with one of the two example datasets that come with the package: + +``` r ExPanD(df = worldbank, df_def = worldbank_data_def, var_def = worldbank_var_def, df_name = "World Bank Data", config_list = ExPanD_config_worldbank) + +ExPanD(df = russell_3000, + df_def = russell_3000_data_def, + df_name = "Russell 3000", + config_list = ExPanD_config_russell_3000) ``` Further Information diff --git a/_pkgdown.yml b/_pkgdown.yml index 2a430a1..2dc7558 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -2,7 +2,7 @@ template: params: ganalytics: UA-119053376-1 development: - mode: unreleased + mode: release navbar: structure: left: diff --git a/cran-comments.md b/cran-comments.md index 11410e7..1e9ad23 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -13,10 +13,13 @@ ## Resubmission This is a resubmission. In this version I have: -* Reduced the amount of data and the quality of the jpgs in the vognettes +* Reduced the amount of data and the quality of the jpegs in the vignettes so that the total size of the source tar ball is below 5 MB * Rewritten the DESCRIPTION file to avoid redundancies * Put all references to software in the DESCRIPTION file in single quotes +* I did not add any paper references to the Description field as the package + uses standard EDA methodology. + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index ee19842..46a407d 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -68,7 +68,7 @@ ExPanDaR - 0.2.0 + 0.2.0 diff --git a/docs/articles/index.html b/docs/articles/index.html index d9a398e..78920b0 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -68,7 +68,7 @@ ExPanDaR - 0.2.0 + 0.2.0 diff --git a/docs/authors.html b/docs/authors.html index 646137d..994ddf9 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -68,7 +68,7 @@ ExPanDaR - 0.2.0 + 0.2.0 diff --git a/docs/index.html b/docs/index.html index 578ee08..de6b999 100644 --- a/docs/index.html +++ b/docs/index.html @@ -42,7 +42,7 @@ ExPanDaR - 0.2.0 + 0.2.0 @@ -100,7 +100,10 @@

ExPanDaR: Explore Panel Data Interactively

-

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Travis-CI Build Status

+

Project Status: Active – The project has reached a stable, usable state and is being actively developed. Travis-CI Build Status CRAN_Status_Badge

+
+

+Overview

This is the documentation of the ExPanDaR (Explore Panel Data with R) package. ExPanDaR provides the code base for the ExPanD web app. ExPanD is a shiny based app supporting interactive exploratory data analysis.

ExPanD has two purposes:

    @@ -112,20 +115,43 @@

    If you are interested to see what ExPanD has to offer without diving into R, click here to explore an instance of ExPanD that hosts World Bank data or click here for a financial accounting and stock returns dataset of U.S. firms.

    If you want to analyze your own panel data instead, you can also access a variant of ExPanD app here that allows user-side data uploads. No worries: Your data won’t be stored on the server and will get erased from memory as soon as you close the web connection.

    -

    Finally, if you are in for the full treat and want to test ExPanD from within R, run the following in your R session to start exploring World Bank data.

    +
+
+

+Installation

+

If you are in for the full treat and want to test ExPanD from within R, run the following in your R session to install the ExPanDaR package from CRAN.

+
install.packages("ExPanDaR")
+library(ExPanDaR)
+

Or, if you want to install the current development version from Github:

if (!require("devtools")) {
   install.packages("devtools")
 }
 devtools::install_github("joachim-gassen/ExPanDaR")
-library(ExPanDaR)
-
-ExPanD(df = worldbank,  
+library(ExPanDaR)
+
+
+

+Basic Usage

+

You can either start ExPanD without arguments so that it starts with a file upload dialog…

+
ExPanD()
+

…or start with one of the two example datasets that come with the package:

+
ExPanD(df = worldbank,  
        df_def = worldbank_data_def, 
        var_def = worldbank_var_def,
        df_name = "World Bank Data",
-       config_list = ExPanD_config_worldbank)
+ config_list = ExPanD_config_worldbank) + +ExPanD(df = russell_3000, + df_def = russell_3000_data_def, + df_name = "Russell 3000", + config_list = ExPanD_config_russell_3000)
+
+
+

+Further Information

For further information, please refer to the articles and function call references available on this page.

Enjoy!

+
@@ -133,6 +159,8 @@

Links

diff --git a/docs/reference/index.html b/docs/reference/index.html index 4d12159..8ef580c 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -68,7 +68,7 @@ ExPanDaR - 0.2.0 + 0.2.0
diff --git a/index.Rmd b/index.Rmd index bb0ea6a..b36faba 100644 --- a/index.Rmd +++ b/index.Rmd @@ -14,8 +14,11 @@ library(knitr) [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/latest/active.svg)](http://www.repostatus.org/#active) [![Travis-CI Build Status](https://travis-ci.org/joachim-gassen/ExPanDaR.svg?branch=master)](https://travis-ci.org/joachim-gassen/ExPanDaR) +[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ExPanDaR)](https://cran.r-project.org/package=ExPanDaR) +## Overview + This is the documentation of the ExPanDaR (Explore Panel Data with R) package. ExPanDaR provides the code base for the ExPanD web app. ExPanD is a shiny based app supporting interactive exploratory data analysis. ExPanD has two purposes: @@ -36,8 +39,18 @@ If you are interested to see what ExPanD has to offer without diving into R, cli If you want to analyze your own panel data instead, you can also access a variant of ExPanD app [here](https://jgassen.shinyapps.io/expand/) that allows user-side data uploads. No worries: Your data won't be stored on the server and will get erased from memory as soon as you close the web connection. -Finally, if you are in for the full treat and want to -test ExPanD from within R, run the following in your R session to start exploring World Bank data. + +## Installation + +If you are in for the full treat and want to test ExPanD from within R, run the following +in your R session to install the ExPanDaR package from CRAN. + +```{r, eval=FALSE} +install.packages("ExPanDaR") +library(ExPanDaR) +```` + +Or, if you want to install the current development version from Github: ```{r, eval=FALSE} if (!require("devtools")) { @@ -45,14 +58,35 @@ if (!require("devtools")) { } devtools::install_github("joachim-gassen/ExPanDaR") library(ExPanDaR) +```` + +## Basic Usage + +You can either start ExPanD without arguments so that it starts with a file upload dialog... + +```{r, eval=FALSE} +ExPanD() +```` + +...or start with one of the two example datasets that come with the package: + +```{r, eval=FALSE} ExPanD(df = worldbank, df_def = worldbank_data_def, var_def = worldbank_var_def, df_name = "World Bank Data", config_list = ExPanD_config_worldbank) + +ExPanD(df = russell_3000, + df_def = russell_3000_data_def, + df_name = "Russell 3000", + config_list = ExPanD_config_russell_3000) ```` + +## Further Information + For further information, please refer to the articles and function call references available on this page. Enjoy!