From 85d50763f98ea2b9a79267167b08351ed0dddaf8 Mon Sep 17 00:00:00 2001 From: paul <> Date: Sat, 8 Apr 2023 00:28:29 +0200 Subject: [PATCH] render readme update with links to comtrade --- README.Rmd | 8 +++++--- README.md | 18 +++++++++++++++++- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.Rmd b/README.Rmd index 2ee649f..f350338 100644 --- a/README.Rmd +++ b/README.Rmd @@ -68,6 +68,8 @@ ggplot2::ggplot(exports) + ## Next steps -- [ ] Implement tests for unchecked arguments, such as period, motCode and the frequency. -- [ ] Implement the different modes of transportation -- [ ] Properly document all functions, including some more links to the UN Comtrade API FAQ. +- [ ] Implement tests for unchecked arguments, such as period, motCode and the frequency. + +- [ ] Implement the different modes of transportation + +- [ ] Properly document all functions, including some more links to the UN Comtrade API FAQ. diff --git a/README.md b/README.md index 915b9db..7718642 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,10 @@ Check](https://github.com/datapumpernickel/untrader/actions/workflows/R-CMD-chec The goal of untrader is to provide a simple wrapper function for the new -Comtrade API of the UN. +[Comtrade API of the UN](https://comtradeplus.un.org/). + +The package is currently under development, please be careful when +interpreting results from the API. ## Installation @@ -27,6 +30,9 @@ This is a basic example which shows you how to solve a common problem: ``` r library(untrader) +## you need to set your API key first +# set_primary_comtrade_key() + exports <- get_comtrade_data(freq = 'A', clCode = 'HS', cmdCode = '2204,2203', @@ -52,3 +58,13 @@ ggplot2::ggplot(exports) + ``` + +## Next steps + +- [ ] Implement tests for unchecked arguments, such as period, motCode + and the frequency. + +- [ ] Implement the different modes of transportation + +- [ ] Properly document all functions, including some more links to the + UN Comtrade API FAQ.