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

Add vignettes to demonstrate usage of the package #123

Closed
ha0ye opened this issue Apr 25, 2018 · 1 comment
Closed

Add vignettes to demonstrate usage of the package #123

ha0ye opened this issue Apr 25, 2018 · 1 comment
Assignees

Comments

@ha0ye
Copy link
Member

ha0ye commented Apr 25, 2018

In prep for a submission to CRAN and JOSS, it would be ideal to have several vignettes with short examples of using the portalr functions to get the Portal data and do some simple analyses or plots.

Here's a suggested workflow for writing a vignette:

  1. Make a new Rmarkdown file within the vignettes folder.
  • If you're using RStudio, you can select "From Template" -> "Package Vignette (HTML)"
  • You can also try devtools::use_vignette("<vignette name>")
  1. Follow standard Rmarkdown for writing the vignette.
  2. Use devtools::build_vignettes() to build and include the vignette files to the package.
  3. (standard Git add, commit, push, pull-request)

Note, if you use packages in the vignette that aren't dependencies of portalr, make sure to include them in the DESCRIPTION file under Suggests:

There's an example already in the vignettes folder that you can take a look at.

@ha0ye ha0ye added this to the Release ver 1.0 milestone May 30, 2018
@ha0ye ha0ye changed the title Add vignette to document options for retrieving data Add vignettes to demonstrate usage of the package Jun 27, 2018
@ha0ye ha0ye removed this from the Release ver 0.1 milestone Jul 27, 2018
@gmyenni
Copy link
Collaborator

gmyenni commented Aug 27, 2018

  • Estimating missing data/Adjusting for effort

  • Energy

  • Phenology

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

5 participants