Skip to content

Commit

Permalink
updated vignettes with some spelluing and transition info
Browse files Browse the repository at this point in the history
  • Loading branch information
datapumpernickel committed Dec 22, 2023
1 parent 01f19eb commit e70be60
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions man/comtradr-package.Rd

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

2 changes: 1 addition & 1 deletion vignettes/comtradr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -349,7 +349,7 @@ If `flow_direction` is set to `everything`, all possible values for trade flow d

### `reporter` and `partner`

Using `everything` for `reporter` or `partner` will query all possible values for reporter and partner countries, but also includes aggregates like `World` or some miscellaneous like `ASEAN`. Be careful when aggregating these values, so as to not count trade values multiple times in different aggregates. Alterantively, specificely for these values, you can also use `all_countries`, which allows you to query all countries which are not aggregates of some kind of grouped parameters like `ASEAN`. These values can usually be safely aggregated. This allows you to retrieve trade data for all countries without specifying individual ISO3 codes.
Using `everything` for `reporter` or `partner` will query all possible values for reporter and partner countries, but also includes aggregates like `World` or some miscellaneous like `ASEAN`. Be careful when aggregating these values, so as to not count trade values multiple times in different aggregates. Alternatively, specifically for these values, you can also use `all_countries`, which allows you to query all countries which are not aggregates of some kind of grouped parameters like `ASEAN`. These values can usually be safely aggregated. This allows you to retrieve trade data for all countries without specifying individual ISO3 codes.

### `mode_of_transport`, `partner_2`, and `customs_code`

Expand Down
4 changes: 2 additions & 2 deletions vignettes/transition.Rmd
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Transition"
title: "Transition from old comtradr"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{transition}
Expand All @@ -18,7 +18,7 @@ possible parameter values.
With the below examples, we hope to make the transition a little easier. Most
of the design principles of the package have remained similar.

The most important changes can be summarised in that the package:
The most important changes can be summarized in that the package:
- extensively checks parameters for validity before submitting
them
- allows iso3 standardized country codes as inputs
Expand Down

0 comments on commit e70be60

Please sign in to comment.