-install.packages(c('devtools', 'pkgdown', 'styler', 'lintr')) # install dev dependencies
-devtools::install_deps(dependencies = TRUE) # install package dependencies
-devtools::document() # generate package meta data and man files
-devtools::build() # build packageinstall.packages(c('devtools', 'pkgdown', 'styler', 'lintr', 'pak')) # install dev dependencies
+pak::pkg_install(".") # install package and dependenciesThe documentation site is built off of the main branch. The dev version of the site is available at https://cmu-delphi.github.io/epipredict/dev.
The documentation site can be previewed locally by running in R
-
-pkgdown::build_site(preview=TRUE)The main version is available at file:///<local path>/epidatr/epipredict/index.html and dev at file:///<local path>/epipredict/docs/dev/index.html.
You can also build the docs manually and launch the site with python. From the terminal, this looks like
-R -e 'pkgdown::clean_site()'
-R -e 'devtools::document()'
-R -e 'pkgdown::build_site()'
-python -m http.server -d docsOur CI builds two versions of the documentation:
+main branch anddev branch.Commands for developing the documentation site:
+# Basic build and preview
+R -e 'pkgdown::clean_site()'
+R -e 'devtools::document()'
+R -e 'pkgdown::build_site()'If you work without R Studio and want to iterate on documentation, you might find this script helpful.
Please follow the guidelines in the PR template document.
Open a release issue and then copy and follow this checklist in the issue (modified from the checklist generated by usethis::use_release_issue(version = "1.0.2")):
Submit to CRAN:
+Wait for CRAN…
+