Skip to content

Package Development

Primary commands used when developing a package.

build()
Build package
build_manual()
Create package pdf manual
build_rmd() build_readme()
Build a Rmarkdown files package
build_site()
Execute pkgdown build_site in a package
build_vignettes()
Build package vignettes.
check() check_built()
Build and check a package, cleaning up automatically on success.
check_mac_release()
Check macOS package
check_man()
Check documentation, as R CMD check does.
check_rhub()
Run CRAN checks for package on R-hub
check_win_devel() check_win_release() check_win_oldrelease()
Build windows binary package.
create()
Create a package
document()
Use roxygen to document a package.
load_all()
Load complete package
reload()
Unload and reload package.
release()
Release package to CRAN.
spell_check()
Spell checking
test() test_active_file() test_coverage() test_coverage_active_file()
Execute testthat tests in a package

Package Installation

install()
Install a local development package.
install_deps() install_dev_deps()
Install package dependencies if needed.
uninstall()
Uninstall a local development package

Utilities

bash()
Open bash shell in package directory.
clean_vignettes()
Clean built vignettes.
dev_mode()
Activate and deactivate development mode.
dev_sitrep()
Report package development situation
reexports parse_deps check_dep_version with_debug clean_dll has_devel find_rtools unload github_pull github_release session_info package_info
Objects exported from other packages
lint()
Lint all source files in a package
missing_s3()
Find missing s3 exports.
run_examples()
Run all examples in a package.
show_news()
Show package news
source_gist()
Run a script on gist
source_url()
Run a script through some protocols such as http, https, ftp, etc.
install_bioc() install_bitbucket() install_cran() install_dev() install_git() install_github() install_gitlab() install_local() install_svn() install_url() install_version() update_packages() dev_package_deps()
Functions re-exported from the remotes package
wd()
Set working directory.
save_all()
Save all documents in an active IDE session.