Package Development

Primary commands used when developing a package.

build()

Build package

check() check_built()

Build and check a package, cleaning up automatically on success.

check_failures()

Parses R CMD check log file for ERRORs, WARNINGs and NOTEs

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.

build_manual()

Create package pdf manual

build_readme()

Build a Rmarkdown README for a package

build_site()

Execute pkgdown build_site in a package

build_vignettes()

Build package vignettes.

document()

Use roxygen to document a package.

load_all()

Load complete package.

package_file()

Find file in a package.

devtools

Package development tools for R.

reload()

Unload and reload package.

release()

Release package to CRAN.

revdep() revdep_maintainers()

Reverse dependency tools.

test() test_coverage() uses_testthat() test_file() test_coverage_file()

Execute test_that tests in a package.

spell_check()

Spell checking

Package Installation

install()

Install a local development package.

install_deps() install_dev_deps()

Install package dependencies if needed. install_deps() will install the user dependencies needed to run the package, install_dev_deps() will also install the development dependencies needed to test and build the package.

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.

dr_devtools()

Diagnose potential devtools issues

dr_github()

Diagnose potential GitHub issues

reexports

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.

wd()

Set working directory.

save_all()

Save all documents in an active IDE session.