-
Notifications
You must be signed in to change notification settings - Fork 0
Add examples #42
Copy link
Copy link
Labels
qcthat-nocov{qcthat}: Do not include in issue-test coverage reports{qcthat}: Do not include in issue-test coverage reports
Milestone
Metadata
Metadata
Assignees
Labels
qcthat-nocov{qcthat}: Do not include in issue-test coverage reports{qcthat}: Do not include in issue-test coverage reports
Add examples to all exported functions. Find the list of exported functions in NAMESPACE.
Any function that hits the internet (
iterate_with_json_cursor,req_perform_opinionated) should use@examplesIf httr2::is_online(). If the objects processed by a function is too complex to include in the example,usethis::use_data_raw("example_data")(ifdata-raw/example_data.Rdoesn't exist yet), prepare the dataset indata-raw/example_data.R, thenusethis::use_data({ThisDatasetName}, overwrite = TRUE). Such datasets should be namedexample_{descriptive_name}insnake_case. Try to minimize example datasets and reuse an existing example dataset if possible. We will also need to document such datasets, with the instructions here: https://r-pkgs.org/data.html#sec-documenting-data