CRAN 0.2.0 is live

joachim-gassen · May 12, 2018 · 3e60223 · 3e60223
1 parent 7347b6d
commit 3e60223
Show file tree

Hide file tree

Showing 10 changed files with 135 additions and 20 deletions.
diff --git 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,21 +39,46 @@ 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")) {
   install.packages("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
@@ -2,7 +2,7 @@
 ExPanDaR: Explore Panel Data Interactively <img src="logo.png" align="right" />
 ===============================================================================
 
-[![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,20 +27,45 @@ 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")) {
   install.packages("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
@@ -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
@@ -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
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git 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,23 +39,54 @@ 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")) {
   install.packages("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!