You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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>")
Follow standard Rmarkdown for writing the vignette.
Use devtools::build_vignettes() to build and include the vignette files to the package.
(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.
The text was updated successfully, but these errors were encountered:
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:
vignettes
folder.devtools::use_vignette("<vignette name>")
devtools::build_vignettes()
to build and include the vignette files to the package.Note, if you use packages in the vignette that aren't dependencies of portalr, make sure to include them in the
DESCRIPTION
file underSuggests:
There's an example already in the
vignettes
folder that you can take a look at.The text was updated successfully, but these errors were encountered: