Home

Installation du package [FR]

Pour installer le package JDCruncheR il y a actuellement deux solutions. La première est d'utiliser le package devtools en lançant tout simplement la commande suivante :

# install.packages("devtools")
devtools::install_github("InseeFr/JDCruncheR")

L'inconvénient de cette méthode est que l'installation peut ne pas marcher en fonction du réseau internet car pour des raisons de sécurité il peut être nécessaire de configurer le proxy. Quelques méthodes pour le configurer sont détaillées dans la page Configuration du proxy sous RStudio. L'avantage de cette méthode est de s'assurer que l'on a bien installé la dernière version en ligne.

La seconde solution est d'installer le package à partir du .zip ou du .tar.gz du package qui peuvent être téléchargés à l'adresse https://github.com/InseeFr/JDCruncheR/releases. Cette solution ne nécessite pas de configuration de proxy mais l'on n'est pas assuré d'avoir la toute dernière version d'installée.

Utilisation du package [FR]

Pour utiliser le package JDCruncheR il faut avoir téléchargé le cruncher de JDemetra+ (JWSACruncher). La dernière version du cruncher (2.2.3) peut être téléchargée ici https://github.com/jdemetra/jwsacruncher/releases (fichier jwsacruncher-2.2.3.zip) et les anciennes versions sont téléchargeables sous https://github.com/jdemetra/jdemetra-core/releases. La version 8 de Java (ou toute version supérieure) est nécessaire pour utiliser la version 2.2.3 du cruncher. Si l'on n'a pas cette version de Java (par exemple parce que l'on n'a pas les droits administrateur pour l'installer) on peut utiliser une version portable de Java 8 : il faut alors faire une modification supplémentaire pour rendre le cruncher compatible avec cette version portable (voir partie Installation et configuration de JDemetra et du cruncher ).

Lorsque le package JDCruncheR est chargé, trois options sont initialisées : cruncher_bin_directory, default_matrix_item et default_tsmatrix_series. La première correspond au chemin vers le répertoire "Bin" du cruncher, la deuxième aux paramètres qui seront par défaut exportés en lançant le cruncher et la troisième les séries temporelles qui seront par défaut exportés en lançant le cruncher. Pour voir leurs valeurs il suffit d'utiliser le code suivant :

library(JDCruncheR)
getOption("cruncher_bin_directory")
getOption("default_matrix_item")
getOption("default_tsmatrix_series")

Pour les modifier il faut utiliser la fonction options() :

options(cruncher_bin_directory = "Adresse vers le dossier bin du cruncher")

Une fois l'option cruncher_bin_directory modifiée vers la bonne adresse, pour lancer rapidement le cruncher on peut utiliser la fonction cruncher_and_param(). Si besoin, on peut spécifier à cette fonction des paramètres supplémentaires sur le format de sortie des données (voir paramètres de la fonction create_param_file) :

library(JDCruncheR)
# Configuration du chemin vers le cruncher
options(cruncher_bin_directory = "Adresse vers le dossier bin du cruncher")
# Par exemple pour utiliser "lastoutliers" comme méthode de rafraîchissement :
cruncher_and_param(policy = "lastoutliers")

Package installation [EN]

There are two ways to install the JDCruncheR package. The first uses the devtools package:

# install.packages("devtools")
devtools::install_github("InseeFr/JDCruncheR")

This might not works because of network security parameters. In which case, the proxy will have to be configured (cf. proxy configuration). This method ensures the version installed is the latest available.

The second solution is to install the package from the .zip or .tar.gz file, that can both be downloaded here: https://github.com/InseeFr/JDCruncheR/releases. This solution doesn't require to edit the proxy but the version downloaded might not be the most recent.

How to use the package [EN]

To use the JDCruncheR package, you must have downloaded the JDemetra+ cruncher (JWSACruncher) beforehand. The latest cruncher version (2.2.3) can be downloaded here https://github.com/jdemetra/jwsacruncher/releases (file jwsacruncher-2.2.3.zip) and the previous versions, here: https://github.com/jdemetra/jdemetra-core/releases. Java 8 or above is required to use this version of the cruncher. If a lower version of Java is installed on your computer and you don't have the rights to upgrade it, you can resort to a portable version (cf. Installation and configuration of JDemetra and the cruncher ).

When the JDCruncheR package is loaded, three options are initialised: cruncher_bin_directory, default_matrix_item and default_tsmatrix_series. The first is the path to the cruncher "bin" directory, the second is the list of variables that will be exported by default when calling the cruncher and the third is the list of time series that will be exported by default when the cruncher is called. To display their value, compute:

library(JDCruncheR)
getOption("cruncher_bin_directory")
getOption("default_matrix_item")
getOption("default_tsmatrix_series")

To edit them, use the function options():

options(cruncher_bin_directory = "Path to the cruncher bin directory")

Once the cruncher_bin_directory contains the right path, the cruncher can be called via the function cruncher_and_param(). Additionnal output parameters can be also specified (cf. the create_param_file arguments):

library(JDCruncheR)
# Setting the path to the cruncher
options(cruncher_bin_directory = "path to the cruncher bin directory")
# Example: to use the "lastoutliers" refresh policy
cruncher_and_param(policy = "lastoutliers")