Skip to content

Commit

Permalink
Minor clarification for Usability Fixes #10
Browse files Browse the repository at this point in the history
  • Loading branch information
realxinzhao committed Mar 16, 2024
1 parent 1c77356 commit 2005d03
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions R/xfaostat_helper_funcs.R
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ FF_download_FAOSTAT <- function(DATASETCODE,
assertthat::assert_that(is.character(DATASETCODE))
assertthat::assert_that(is.character(DATA_FOLDER))
assertthat::assert_that(OverWrite == TRUE|OverWrite == FALSE)
assertthat::assert_that(length(DATASETCODE) == 1, msg = "Single dataset allowed; consider using loop or the function FF_rawdata_info() for downloading multiple datasets")
assertthat::assert_that(length(DATASETCODE) == 1, msg = "Single dataset allowed; consider using a loop or the function FF_rawdata_info() for downloading multiple datasets")

dir.create(DIR_RAW_DATA_FAOSTAT, showWarnings = F)

Expand Down Expand Up @@ -152,7 +152,7 @@ FF_download_RemoteArchive <-
assertthat::assert_that(is.character(RemoteArchiveURL))
assertthat::assert_that(is.character(DATA_FOLDER))
assertthat::assert_that(OverWrite == TRUE|OverWrite == FALSE)
assertthat::assert_that(length(DATASETCODE) == 1, msg = "Single dataset allowed; consider using loop or the function FF_rawdata_info() for downloading multiple datasets")
assertthat::assert_that(length(DATASETCODE) == 1, msg = "Single dataset allowed; consider using a loop or the function FF_rawdata_info() for downloading multiple datasets")

dir.create(DATA_FOLDER, showWarnings = F)

Expand Down
4 changes: 2 additions & 2 deletions vignettes/vignette_getting_started.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ Users should now be ready to run the driver, which is the main processing functi

2. `driver()`

See [here](https://jgcri.github.io/gcamdata/reference/driver.html) for more options when running the driver, such as what outputs to generate or when to stop.
See [here](https://jgcri.github.io/gcamdata/reference/driver.html) for more options when running the driver, such as what outputs to generate or when to stop.

For `gcamfaostat`, it is recommended to use `driver_drake()` so the data tracing and exploring after the drive will be possible, even thought it may take longer to run and additional space (for drake cache) compared to `driver()`.
For `gcamfaostat`, it is recommended to use `driver_drake()` so the data tracing and exploring after the drive will be possible, even thought it may take longer to run and additional space (for drake cache) compared to `driver()`. The `driver()` approach has a default option (`write_outputs = T`) to write the intermediate `csv` outputs to `./outputs`.

#### Output files
* In `constants.R`, users can set `OUTPUT_Export_CSV == TRUE` and specify the output directory (`DIR_OUTPUT_CSV`) to export and store the output csv files.
Expand Down

0 comments on commit 2005d03

Please sign in to comment.