Skip to content

Package development

Primary commands used when developing a package.

build()
Build package
build_manual()
Create package pdf manual
build_readme()
Build README
build_site()
Run pkgdown::build_site()
check() check_built()
Build and check a package
check_doc_fields()
Check for missing documentation fields
check_mac_release() check_mac_devel()
Check a package on macOS
check_man()
Check documentation, as R CMD check does
check_win_devel() check_win_release() check_win_oldrelease()
Check a package on Windows
document()
Use roxygen to document a package
load_all()
Load complete package
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
uninstall()
Uninstall a local development package

Utilities

dev_sitrep()
Report package development situation
lint()
Lint all source files in a package
run_examples()
Run all examples in a package
reexports parse_deps check_dep_version with_debug clean_dll has_devel find_rtools is_loading unload session_info package_info
Objects exported from other packages
source_gist()
Run a script on gist
source_url()
Run a script through some protocols such as http, https, ftp, etc
save_all()
Save all documents in an active IDE session

Deprecated

bash() deprecated
Open bash shell in package directory
build_rmd() deprecated
Build Rmarkdown files
build_vignettes() deprecated
Build package vignettes
clean_vignettes() deprecated
Clean built vignettes
create() deprecated
Create a package
dev_mode() deprecated
Activate and deactivate development mode
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() github_pull() github_release() deprecated
Deprecated package installation functions
install_deps() install_dev_deps() deprecated
Install package dependencies if needed
missing_s3() deprecated
Find missing s3 exports
reload() deprecated
Unload and reload package
release() deprecated
Release package to CRAN
show_news() deprecated
Show package news
wd() deprecated
Set working directory
test_file() test_coverage_file()
Defunct functions