Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use canned data in vignettes #33

Closed
florianm opened this issue Oct 14, 2019 · 0 comments
Closed

Use canned data in vignettes #33

florianm opened this issue Oct 14, 2019 · 0 comments
Assignees
Milestone

Comments

@florianm
Copy link
Collaborator

florianm commented Oct 14, 2019

Problem

Karissa found:

  • Installation succeeds as documented.
  • remotes::install_github() works by default, but fails when build_vignettes = TRUE if you do not have your credentials stored prior to build.

Jason found same breakage with auth credentials not available in devtools::install(build_vignettes=TRUE).

Solution

  • Have a squizzle at https://github.com/ropensci/rcites/blob/master/vignettes/a_get_started.Rmd for best practices: Vignettes decide whether or not to eval code chunks based on an environment variable (in this case NOT_CRAN) and both ways are tested in the Travis-CI testing grid. https://github.com/ropensci/rcites/blob/master/.travis.yml
  • Include canned data for all results from all web requests sent by vignettes.
  • This will enable vignettes to build from canned data without the need for ODK Central sandbox credentials.
  • This will require extra tests to verify that canned data is identical to results from web requests.
  • Add a clear delineation as to what can be done with and without test credentials.

source ropensci/software-review#335 (comment)

@florianm florianm added this to the rOpenSci milestone Oct 14, 2019
@florianm florianm self-assigned this Oct 14, 2019
florianm pushed a commit that referenced this issue Nov 25, 2019
Fix #34 - Documentation improvements
Fix #35 - Define "." as global variable
Fix #37 - Hide sensitive settings
Fix #43 - Rename parse_datetime to ru_datetime

#33 Use canned data in vignette "odata-api"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant