use_these.RdWrapper function around several package creation/setup functions from the usethis and snapmeta packages.
use_these(pkg = basename(getwd()), authors = pkg_authors(), cph = pkg_cph())
| pkg | defaults to the name of the working directory. |
|---|---|
| authors | list as generated by |
| cph | copyright holder as generated by |
side effect of setting up various package files and configurations.
use_these calls the following functions: use_authors, use_github_links, use_clone_notes,
use_cran_comments,use_data_raw, use_news_md, use_testthat, use_vignette,
use_readme_rmd, use_revdep, use_lintr, use_appveyor, use_travis and use_coverage.
Authors, clone notes and lintr use are by snapmeta functions. The others are usethis package functions,
except for use_vignettes, which still relies on devtools.
pkgdown for R package website building is also initialized, using a pkgdown directory in the package root
directory containing template _pkgdown.yml and extra.css files relevant to the SNAPverse.
The docs directory is used for website files and should be specified likewise in the repository settings on GitHub.
pkgdown::init_site is also called.
.Rbuildignore is also updated. Make sure to remove the absolute path created by pkgdown::init_site.
Only retain the relative path to the docs directory.
Finally, it adds snapmeta under the DESCRIPTION file Imports field for SNAPverse sector packages.
If needed for any other packages, it must be added manually.
# NOT RUN { use_these() # }