Skip to content

Commit

Permalink
Merge pull request #25 from py-b/options
Browse files Browse the repository at this point in the history
Utilise option pour paramètre telDir
  • Loading branch information
pierre-lamarche authored Oct 6, 2020
2 parents 357747a + a2823c0 commit 001d376
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 11 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Authors@R: c(
)
Description: A package primarily intended for Insee staff members willing to use R in order to exploit and analyse data produced by the institute. This package makes it possible to either download on-the-fly the date from the website, or load pre-processed data. It also provides a (so far non comprehensive) list of datasets available on the website.
Depends: R (>= 3.5.0)
Imports: readr, readxl, stringi, rappdirs, httr, apinsee, jsonlite
Imports: readr, readxl, stringi, httr, apinsee, jsonlite
Suggests: tidyverse, data.table, testthat, RCurl, httpuv
Remotes: rlesur/apinsee
License: MIT + file LICENSE
Expand Down
5 changes: 2 additions & 3 deletions R/telechargerDonnees.R
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
#' Téléchargement des données sur le site de l'Insee
#'
#' @inheritParams telechargerFichier
#' @param donnees le nom des données que l'on souhaite télécharger sur le site de l'Insee, que l'on peut retrouver dans la table [liste_donnees]
#' @param date optionnel : le millésime des données si nécessaire. Peut prendre le format YYYY ou encore DD/MM/YYYY ; dans le dernier cas, on prendra le premier jour de la période de référence.
#' @param telDir optionnel : le dossier dans lequel sont téléchargées les données brutes. Par défaut, un dossier temporaire de cache.
#' @param argsApi optionnel : dans le cas où c'est une API REST qui est utilisée, il est possible de spécifier des paramètres spécifiques à cette API de manière à collecter l'information désirée.
#' @param vars optionnel : un vecteur pour spécifier les variables à importer. Utile pour les données massives difficiles à charger en mémoire, voir @details .
#' @param ... paramètres additionnels relatifs à l'importation des données
Expand All @@ -20,6 +19,6 @@
#' }
#' @importFrom utils download.file unzip read.csv tail
#' @export
telechargerDonnees <- function(donnees, date=NULL, telDir=NULL, argsApi=NULL, vars=NULL, ...) {
telechargerDonnees <- function(donnees, date=NULL, telDir=getOption("doremifasol.telDir"), argsApi=NULL, vars=NULL, ...) {
return(chargerDonnees(telechargerFichier(donnees, date, telDir, argsApi), vars, ...))
}
6 changes: 3 additions & 3 deletions R/telechargerFichier.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' @param donnees le nom des données que l'on souhaite télécharger sur le site de l'Insee, que l'on peut retrouver dans la table ([liste_donnees])
#' @param date optionnel : le millésime des données si nécessaire. Peut prendre le format YYYY ou encore DD/MM/YYYY ; dans le dernier cas, on prendra le premier jour de la période de référence.
#' @param telDir optionnel : le dossier dans lequel sont téléchargées les données brutes. Par défaut, un dossier temporaire de cache.
#' @param telDir optionnel : le dossier dans lequel sont téléchargées les données brutes. Par défaut, la valeur définie par `options(doremifasol.telDir = ...)`. Si l'utilisateur n'a pas défini cette valeur au préalable, un dossier temporaire de cache.
#' @param argsApi optionnel : dans le cas où c'est une API REST qui est utilisée, il est possible de spécifier des paramètres spécifiques à cette API de manière à collecter l'information désirée. Cf. [@details ].
#'
#' @details
Expand All @@ -18,7 +18,7 @@
#' }
#' @importFrom utils download.file unzip read.csv tail
#' @export
telechargerFichier <- function(donnees, date=NULL, telDir=NULL, argsApi=NULL) {
telechargerFichier <- function(donnees, date=NULL, telDir=getOption("doremifasol.telDir"), argsApi=NULL) {
## check the parameter donnees takes a valid value
if (!donnees %in% ld$nom)
stop("Le param\u00e8tre donnees est mal sp\u00e9cifi\u00e9, la valeur n'est pas r\u00e9f\u00e9renc\u00e9e")
Expand All @@ -37,7 +37,7 @@ telechargerFichier <- function(donnees, date=NULL, telDir=NULL, argsApi=NULL) {
#dossier de téléchargement # si NULL aller dans le cache
cache <- FALSE
if (is.null(telDir)) {
telDir <- ifelse(.Platform$OS.type == "windows", tempdir(), rappdirs::user_cache_dir())
telDir <- tempdir()
cache <- TRUE
} else {
if (!dir.exists(telDir))
Expand Down
4 changes: 2 additions & 2 deletions man/telechargerDonnees.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 7 additions & 2 deletions man/telechargerFichier.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 001d376

Please sign in to comment.