Tools to Make Developing R Packages Easier

[Up] [Top]

Documentation for package ‘devtools’ version 1.7.0

Help Pages

devtools-package Package development tools for R.
? Drop-in replacements for help and ? functions
add_path Get/set the PATH variable.
add_rstudio_project Add useful infrastructure to a package.
add_test_infrastructure Add useful infrastructure to a package.
add_travis Add useful infrastructure to a package.
bash Open bash shell in package directory.
build Build package.
build_github_devtools Build the development version of devtools from GitHub.
build_vignettes Build package vignettes.
build_win Build windows binary package.
check Build and check a package, cleaning up automatically on success.
check_doc Check documentation, as 'R CMD check' does.
clean_dll Remove compiled objects from /src/ directory
clean_source Sources an R file in a clean environment.
clean_vignettes Clean built vignettes.
compiler_flags Default compiler flags used by devtools.
compile_dll Compile a .dll/.so from source.
create Creates a new package, following all devtools package conventions.
create_description Create a default DESCRIPTION file for a package.
devtools Package development tools for R.
dev_example Run a examples for an in-development function.
dev_help Read the in-development help for a package loaded with devtools.
dev_mode Activate and deactivate development mode.
document Use roxygen to document a package.
evalq_clean Evaluate code in a clean R session.
eval_clean Evaluate code in a clean R session.
get_path Get/set the PATH variable.
github_pull GitHub references
github_release GitHub references
has_devel Check if you have a development environment installed.
help Drop-in replacements for help and ? functions
infrastructure Add useful infrastructure to a package.
inst Get the installation path of a package
install Install a local development package.
install_bitbucket Install a package directly from bitbucket
install_deps Install package dependencies
install_git Install a package from a git repository
install_github Attempts to install a package directly from github.
install_gitorious Attempts to install a package directly from gitorious.
install_local Install a package from a local file
install_svn Install a package from a SVN repository
install_url Install a package from a url
install_version Install specified version of a CRAN package.
in_dir Execute code in temporarily altered environment.
lint Lint all source files in a package.
load_all Load complete package.
load_code Load R code.
load_data Load data.
load_dll Load a compiled DLL
missing_s3 Find missing s3 exports.
path Get/set the PATH variable.
release Release package to CRAN.
reload Unload and reload package.
revdep Reverse dependency tools.
revdep_check Run R CMD check on all downstream dependencies.
revdep_check_save_logs Run R CMD check on all downstream dependencies.
revdep_check_save_summary Run R CMD check on all downstream dependencies.
revdep_check_summary Run R CMD check on all downstream dependencies.
revdep_maintainers Reverse dependency tools.
run_examples Run all examples in a package.
session_info Print session information
setup Creates a new package, following all devtools package conventions.
set_path Get/set the PATH variable.
shim_help Drop-in replacements for help and ? functions
shim_question Drop-in replacements for help and ? functions
shim_system.file Replacement version of system.file
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.
system.file Replacement version of system.file
test Execute all 'test_that' tests in a package.
unload Unload a package
use_appveyor Add useful infrastructure to a package.
use_cran_comments Add useful infrastructure to a package.
use_data Use data in a package.
use_data_raw Use 'data-raw' to compute package datasets.
use_package Use specified package.
use_package_doc Add useful infrastructure to a package.
use_rcpp Add useful infrastructure to a package.
use_revdep Add useful infrastructure to a package.
use_rstudio Add useful infrastructure to a package.
use_testthat Add useful infrastructure to a package.
use_travis Add useful infrastructure to a package.
use_vignette Add useful infrastructure to a package.
wd Set working directory.
with_collate Execute code in temporarily altered environment.
with_debug Temporarily set debugging compilation flags.
with_env Execute code in temporarily altered environment.
with_envvar Execute code in temporarily altered environment.
with_lib Execute code in temporarily altered environment.
with_libpaths Execute code in temporarily altered environment.
with_locale Execute code in temporarily altered environment.
with_options Execute code in temporarily altered environment.
with_par Execute code in temporarily altered environment.
with_path Execute code in temporarily altered environment.
with_something Execute code in temporarily altered environment.