Learn R Programming

⚠️There's a newer version (1.4.7) of this package.Take me there.

pkgbuild

The goal of pkgbuild is to make it easy to build packages with compiled code. It provides tools to configure your R session, and check that everything is working ok. If you are using RStudio, it also helps you trigger automatic install of the build tools.

Installation

You can install pkgbuild from github with:

# install.packages("devtools")
devtools::install_github("r-lib/pkgbuild")

Example

# Check that you have the build tools installed
pkgbuild::check_build_tools(debug = TRUE)

# Build a package
pkgbuild::build("/path/to/my/package")

# Run your own code in an environment guaranteed to 
# have build tools available
pkgbuild::with_build_tools(my_code)

Copy Link

Version

Install

install.packages('pkgbuild')

Monthly Downloads

414,079

Version

1.1.0

License

GPL-3

Issues

Pull Requests

Stars

Forks

Maintainer

Jim Hester

Last Published

July 13th, 2020

Functions in pkgbuild (1.1.0)

compile_dll

Compile a .dll/.so from source.
pkg_has_src

Does a source package have src/ directory?
needs_compile

Does the package need recompiling? (i.e. is there a source or header file newer than the dll)
rcmd_build_tools

Call R CMD 'command' with build tools active
rtools_needed

Retrieve a text string with the rtools version needed
has_build_tools

Are build tools are available?
has_compiler

Is a compiler available?
pkg_links_to_rcpp

Test if a package path is linking to Rcpp or cpp11
has_latex

Is latex installed?
rtools_path

Is Rtools installed?
pkgbuild_process

Build package in the background
clean_dll

Remove compiled objects from /src/ directory
with_debug

Temporarily set debugging compilation flags.
build

Build package
without_compiler

Tools for testing pkgbuild
compiler_flags

Default compiler flags used by devtools.