CRAN release

AQLT · Jun 16, 2019 · 88806be · 88806be
1 parent 50309a5
commit 88806be
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 42 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,15 +5,14 @@ Authors@R: c(person("Alain", "Quartier-la-Tente", role = c("aut", "cre"),
                  email = "[email protected]"))
 Description: 'JDemetra+' (<https://github.com/jdemetra/jdemetra-app>) is the seasonal adjustment software officially recommended
   to the members of the European Statistical System and the European System of Central Banks. Seasonal adjustment models performed
-  with 'JDemetra' can be stored into workspaces. 'JWSACruncher' (<https://github.com/jdemetra/jwsacruncher/releases>) is a console tool that 
+  with 'JDemetra+' can be stored into workspaces. 'JWSACruncher' (<https://github.com/jdemetra/jwsacruncher/releases>) is a console tool that 
   re-estimates all the multi-processing defined in a workspace and to export the result. 'rjwsacruncher' allows to launch easily the 'JWSACruncher'.
 URL: https://github.com/AQLT/rjwsacruncher
 BugReports: https://github.com/AQLT/rjwsacruncher/issues
 Imports:
     XML
 Suggests:
     knitr,
-    kableExtra,
     rmarkdown
 License: GPL-3
 VignetteBuilder: knitr

diff --git a/R/param_file.R b/R/param_file.R
@@ -28,11 +28,14 @@
 #' @seealso \code{\link{cruncher_and_param}}.
 #' @encoding UTF-8
 #' @export
-create_param_file <- function(dir_file_param = getwd(), bundle = 10000, csv_layout = "list", csv_separator = ";",
+create_param_file <- function(dir_file_param, bundle = 10000, csv_layout = "list", csv_separator = ";",
                               ndecs = 6, policy = "parameters", output = NULL,
                               matrix_item = getOption("default_matrix_item"),
                               tsmatrix_series = getOption("default_tsmatrix_series"),
                               paths_path = NULL){
+    if (missing(dir_file_param))
+        stop("The parameter dir_file_param is missing")
+
     first_line <- "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"yes\"?>"
     param_line <- paste("<wsaConfig bundle=", bundle, " csvlayout=", csv_layout, " csvseparator=",
                         csv_separator, " ndecs=",ndecs,">", sep = "\"")
@@ -70,7 +73,3 @@ create_param_file <- function(dir_file_param = getwd(), bundle = 10000, csv_layo
     writeLines(file_param, con = paste0(dir_file_param,"/parameters.param"))
     return(invisible(paste0(dir_file_param,"/parameters.param")))
 }
-
-
-
-
diff --git a/README.Rmd b/README.Rmd
@@ -11,26 +11,29 @@ knitr::opts_chunk$set(
   fig.path = "README-",
   fig.align = "center"
 )
+library(rjwsacruncher)
 ```
 
 # rjwsacruncher
 
-[![Travis Build Status](https://travis-ci.org/AQLT/rjwsacruncher.svg?branch=master)](https://travis-ci.org/AQLT/rjwsacruncher)
-[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rjdemetra)](https://cran.r-project.org/package=rjdemetra)
+[![Travis Build Status](https://img.shields.io/travis/AQLT/rjwsacruncher.svg?logo=travis)](https://travis-ci.org/AQLT/rjwsacruncher)
+[![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rjwsacruncher)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN last release](http://www.r-pkg.org/badges/last-release/rjwsacruncher)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN monthly downloads](http://cranlogs.r-pkg.org/badges/rjwsacruncher?color=lightgrey)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN downloads](http://cranlogs.r-pkg.org/badges/grand-total/rjwsacruncher?color=lightgrey)](https://cran.r-project.org/package=rjwsacruncher)
 
 
-The goal of rjwsacruncher is to launch quickly and easily the [JWSACruncher](https://github.com/jdemetra/jwsacruncher) of [JDemetra+](https://github.com/jdemetra/jdemetra-app). The JWSACruncher is a console tool that allows to update a JDemetra+ workspace's and to export the results without having to use JDemetra+. More details on the JWSACruncher can be found on <https://github.com/jdemetra/jwsacruncher/wiki>.
+The goal of rjwsacruncher is to launch quickly and easily the [JWSACruncher](https://github.com/jdemetra/jwsacruncher) of [JDemetra+](https://github.com/jdemetra/jdemetra-app). The JWSACruncher is a console tool that allows to update a JDemetra+ workspace and to export the results without having to open JDemetra+. More details on the JWSACruncher can be found on <https://github.com/jdemetra/jwsacruncher/wiki>.
 
 ## Installation
-```{r, include = FALSE}
-library(rjwsacruncher)
-```
-
-The development version can be installed from GitHub:
 
 ```{r gh-installation, eval = FALSE}
+# Install release version from CRAN
+install.packages("rjwsacruncher")
+
+# Install development version from GitHub
 # install.packages("devtools")
-devtools::install_github("AQLT/rjwsacruncher", build_vignettes = TRUE)
+devtools::install_github("AQLT/rjwsacruncher")
 ```
 
 The JWSACruncher is not included in the package. It can be downloaded from GitHub (<https://github.com/jdemetra/jwsacruncher/releases>) or with the function `download_cruncher()`:

diff --git a/README.md b/README.md
@@ -4,24 +4,32 @@
 # rjwsacruncher
 
 [![Travis Build
-Status](https://travis-ci.org/AQLT/rjwsacruncher.svg?branch=master)](https://travis-ci.org/AQLT/rjwsacruncher)
-[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rjdemetra)](https://cran.r-project.org/package=rjdemetra)
+Status](https://img.shields.io/travis/AQLT/rjwsacruncher.svg?logo=travis)](https://travis-ci.org/AQLT/rjwsacruncher)
+[![CRAN\_Status\_Badge](http://www.r-pkg.org/badges/version/rjwsacruncher)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN last
+release](http://www.r-pkg.org/badges/last-release/rjwsacruncher)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN monthly
+downloads](http://cranlogs.r-pkg.org/badges/rjwsacruncher?color=lightgrey)](https://cran.r-project.org/package=rjwsacruncher)
+[![CRAN
+downloads](http://cranlogs.r-pkg.org/badges/grand-total/rjwsacruncher?color=lightgrey)](https://cran.r-project.org/package=rjwsacruncher)
 
 The goal of rjwsacruncher is to launch quickly and easily the
 [JWSACruncher](https://github.com/jdemetra/jwsacruncher) of
 [JDemetra+](https://github.com/jdemetra/jdemetra-app). The JWSACruncher
-is a console tool that allows to update a JDemetra+ workspace’s and to
-export the results without having to use JDemetra+. More details on the
+is a console tool that allows to update a JDemetra+ workspace and to
+export the results without having to open JDemetra+. More details on the
 JWSACruncher can be found on
 <https://github.com/jdemetra/jwsacruncher/wiki>.
 
 ## Installation
 
-The development version can be installed from GitHub:
-
 ``` r
+# Install release version from CRAN
+install.packages("rjwsacruncher")
+
+# Install development version from GitHub
 # install.packages("devtools")
-devtools::install_github("AQLT/rjwsacruncher", build_vignettes = TRUE)
+devtools::install_github("AQLT/rjwsacruncher")
 ```
 
 The JWSACruncher is not included in the package. It can be downloaded

diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/man/create_param_file.Rd b/man/create_param_file.Rd
diff --git a/vignettes/Lancement_cruncher.Rmd → vignettes/run_jwsacruncher.Rmd b/vignettes/Lancement_cruncher.Rmd → vignettes/run_jwsacruncher.Rmd
@@ -7,13 +7,12 @@ output:
     toc_depth: 2
     toc_float: true
 vignette: >
-  %\VignetteIndexEntry{Lancement du cruncher}
+  %\VignetteIndexEntry{Run the 'JWSACruncher' with rjwsacruncher}
   %\VignetteEngine{knitr::rmarkdown}
   \usepackage[utf8]{inputenc}
 ---
 ```{r setup, include=FALSE}
 knitr::opts_chunk$set(echo = TRUE, size = "small")
-library(kableExtra)
 library(knitr)
 ```
 
@@ -100,14 +99,15 @@ options(default_tsmatrix_series = c("sa", "sa_f"))
 
 For more informations, see the help of the function: `?create_param_file`. Below some examples to create the parameter file:
 ```{r, eval = FALSE}
-# To create the file parameters.params in the directory "D:/" with
+export_dir <- tempdir()
+# To create the file parameters.params in the directory export_dir with
 # the refresh policy "lastoutliers" and the others default parameters:
 create_param_file(dir_file_param = "D:/",
                   policy = "lastoutliers")
 
 # If the options "default_matrix_item" and "default_tsmatrix_series" were
 # changed to only export the information criteria, the seasonally adjusted series and its forecasts, the previous code is equivalent to:
-create_param_file(dir_file_param = "D:/",
+create_param_file(dir_file_param = export_dir,
                   policy = "lastoutliers",
                   matrix_item = c("likelihood.aic", "likelihood.aicc",
                                   "likelihood.bic", "likelihood.bicc"),