added examples to legacy functions and ct_build_request, added contri…

…buting file

.github/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to comtradr
+
+This outlines how to propose a change to comtradr. 
+For more detailed info about contributing to this, and other tidyverse packages, please see the
+[**development contributing guide**](https://rstd.io/tidy-contrib). 
+
+## Fixing typos
+
+You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the _source_ file. 
+This generally means you'll need to edit [roxygen2 comments](https://roxygen2.r-lib.org/articles/roxygen2.html) in an `.R`, not a `.Rd` file. 
+You can find the `.R` file that generates the `.Rd` by reading the comment in the first line.
+
+## Bigger changes
+
+If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. 
+If you’ve found a bug, please file an issue that illustrates the bug with a minimal 
+[reprex](https://www.tidyverse.org/help/#reprex) (this will also help you write a unit test, if needed).
+
+### Pull request process
+
+*   Fork the package and clone onto your computer. If you haven't done this before, we recommend using `usethis::create_from_github("ropensci/comtradr", fork = TRUE)`.
+
+*   Install all development dependencies with `devtools::install_dev_deps()`, and then make sure the package passes R CMD check by running `devtools::check()`. 
+    If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing. 
+*   Create a Git branch for your pull request (PR). We recommend using `usethis::pr_init("brief-description-of-change")`.
+
+*   Make your changes, commit to git, and then create a PR by running `usethis::pr_push()`, and following the prompts in your browser.
+    The title of your PR should briefly describe the change.
+    The body of your PR should contain `Fixes #issue-number`.
+
+*  For user-facing changes, add a bullet to the top of `NEWS.md` (i.e. just below the first header). Follow the style described in <https://style.tidyverse.org/news.html>.
+
+### Code style
+
+*   New code should follow the tidyverse [style guide](https://style.tidyverse.org). 
+    You can use the [styler](https://CRAN.R-project.org/package=styler) package to apply these styles, but please don't restyle code that has nothing to do with your PR.  
+
+*  We use [roxygen2](https://cran.r-project.org/package=roxygen2), with [Markdown syntax](https://cran.r-project.org/web/packages/roxygen2/vignettes/rd-formatting.html), for documentation.  
+
+*  We use [testthat](https://cran.r-project.org/package=testthat) for unit tests. 
+   Contributions with test cases included are easier to accept.  
+
+## Code of Conduct
+
+Please note that the comtradr project is released with a
+[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By contributing to this
+project you agree to abide by its terms.

R/ct_build_request.R

@@ -8,6 +8,26 @@
 #'
 #' @param verbose whether the function sends status updates to the console
 #'
+#' @examplesIf interactive()
+#' # Build request from checked parameters
+#' ct_build_request(comtradr:::ct_check_params(type = 'goods',
+#'                                             frequency = 'A',
+#'                                             commodity_classification = 'HS',
+#'                                             commodity_code = 'TOTAL',
+#'                                             flow_direction = 'all',
+#'                                             reporter = 'all',
+#'                                             partner = 'World',
+#'                                             start_date = 2020,
+#'                                             end_date = 2022,
+#'                                             process = TRUE,
+#'                                             tidy_cols = TRUE,
+#'                                             verbose = FALSE,
+#'                                             primary_token = 'xxxx',
+#'                                             mode_of_transport = '0',
+#'                                             partner_2 = 'World',
+#'                                             customs_code ='C00',
+#'                                             update = FALSE ))
+#'
 #' @returns a httr2 request object
 ct_build_request <- function(params,
                                    primary_token = NULL,

R/legacy.R

@@ -3,6 +3,9 @@
 #' `r lifecycle::badge("superseded")`
 #' @param ...  Used to catch all possible arguments that users have supplied to this function.
 #'
+#' @examplesIf interactive()
+#' # no examples because only legacy function
+#'
 #' @export
 #' @returns depreciation error
 ct_commodity_db_type <- function(...) {
@@ -15,6 +18,9 @@ ct_commodity_db_type <- function(...) {
 #' `r lifecycle::badge("superseded")`
 #'
 #' @inheritParams ct_search
+#' @examplesIf interactive()
+#' # no examples because only legacy function
+#'
 #' @export
 #' @returns depreciation error
 ct_country_lookup <- function(...) {
@@ -26,6 +32,8 @@ ct_country_lookup <- function(...) {
 #' @description This function is deprecated Please use  `ct_get_data()` instead.
 #' `r lifecycle::badge("superseded")`
 #' @param ...  Used to catch all possible arguments that users have supplied to this function.
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @export
 #' @returns depreciation error
@@ -38,6 +46,8 @@ ct_search <- function(...) {
 #' @title ct_update_databases
 #' @description This function is deprecated. Please use  `update` parameter in the main `ct_get_data` function instead.
 #' `r lifecycle::badge("superseded")`
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @inheritParams ct_search
 #' @export
@@ -50,6 +60,8 @@ ct_update_databases <- function(...) {
 #' @title ct_use_pretty_cols
 #' @description This function is deprecated. Please use the `process` argument in the main function instead.
 #' `r lifecycle::badge("superseded")`
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @inheritParams ct_search
 #' @export
@@ -62,6 +74,8 @@ ct_use_pretty_cols <- function(...) {
 #' @title ct_get_reset_time
 #' @description This function is deprecated. There is no more reset time, as the upper limit of 250 calls per day is enforced daily.
 #' `r lifecycle::badge("superseded")`
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @inheritParams ct_search
 #' @export
@@ -74,6 +88,8 @@ ct_get_reset_time <- function(...) {
 #' @title ct_get_remaining_hourly_queries
 #' @description This function is deprecated. There is no more reset time, as the upper limit of 250 calls per day is enforced daily.
 #' `r lifecycle::badge("superseded")`
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @inheritParams ct_search
 #' @export
@@ -86,6 +102,8 @@ ct_get_remaining_hourly_queries <- function(...) {
 #' @title ct_register_token
 #' @description This function is deprecated. Please use  `set_primary_comtrade_key()` instead.
 #' `r lifecycle::badge("superseded")`
+#' @examplesIf interactive()
+#' # no examples because only legacy function
 #'
 #' @inheritParams ct_search
 #' @export