Skip to content

Commit

Permalink
Update paper.md
Browse files Browse the repository at this point in the history
  • Loading branch information
realxinzhao committed Apr 4, 2024
1 parent 7539e18 commit 05c5615
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The architecture of **`gcamfaostat`** processing modules is depicted in \autoref
[GCAM v7.0](https://github.com/JGCRI/gcam-core/releases/tag/gcam-v7.0). Each module is essentially an `R` function with well-defined inputs and outputs.


Note that by default, the preprocessed FAOSTAT data, i.e., outputs of the `xfaostat_L101_RawDataPreProc*` modules, have been stored in the [`Prebuilt Data`](https://github.com/JGCRI/gcamfaostat/blob/main/data/PREBUILT_DATA.rda) of the package. **`gcamfaostat`** includes a function to generate metadata ([`gcamfaostat_metadata`](https://jgcri.github.io/gcamfaostat/reference/gcamfaostat_metadata.html)). It accesses both the latest FAOSTAT metadata and local data information and returns a [summary table] (see [example online](https://jgcri.github.io/gcamfaostat/articles/vignette_preparing_data.html#generate-the-metadata-for-the-gcamfaostat-input-data)) including the dataset information needed for **`gcamfaostat`**. There are also functions to download FAOSTAT raw data from either a remote archive [(`FF_download_RemoteArchive`)](https://jgcri.github.io/gcamfaostat/reference/FF_download_RemoteArchive.html) or directly from FAOSTAT [(`FF_download_FAOSTAT`)](https://jgcri.github.io/gcamfaostat/reference/FF_download_FAOSTAT.html).
Note that by default, the preprocessed FAOSTAT data, i.e., outputs of the `xfaostat_L101_*` modules, have been stored in the [`Prebuilt Data`](https://github.com/JGCRI/gcamfaostat/blob/main/data/PREBUILT_DATA.rda) of the package. **`gcamfaostat`** includes a function to generate metadata ([`gcamfaostat_metadata`](https://jgcri.github.io/gcamfaostat/reference/gcamfaostat_metadata.html)). It accesses both the latest FAOSTAT metadata and local data information and returns a [summary table] (see [example online](https://jgcri.github.io/gcamfaostat/articles/vignette_preparing_data.html#generate-the-metadata-for-the-gcamfaostat-input-data)) including the dataset information needed for **`gcamfaostat`**. There are also functions to download FAOSTAT raw data from either a remote archive [(`FF_download_RemoteArchive`)](https://jgcri.github.io/gcamfaostat/reference/FF_download_RemoteArchive.html) or directly from FAOSTAT [(`FF_download_FAOSTAT`)](https://jgcri.github.io/gcamfaostat/reference/FF_download_FAOSTAT.html).

To showcase the flexibility and expandability of our package, we also incorporated two AgLU modules (from `gcamdata`) that exemplify the data aggregation processes, e.g., across regions, sectors, and time. More importantly, the [`driver_drake()`](https://jgcri.github.io/gcamfaostat/reference/driver_drake.html) function plays a pivotal role by executing all available data processing modules, thereby generating both intermediate and final outputs, which are vital components of our comprehensive data processing pipeline. The function was inherited from `gcamdata` and it uses the drake [@Landau2018] pipeline framework, which simplifies module updates, data tracing, and results visualization process.

Expand Down

0 comments on commit 05c5615

Please sign in to comment.