• Stars
    star
    65
  • Rank 455,523 (Top 10 %)
  • Language
    R
  • License
    Other
  • Created over 7 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Find tools needed to build R packages

pkgbuild

R-CMD-check Codecov test coverage

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

Install the released version from CRAN

install.packages("pkgbuild")

Or install the development version from GitHub:

# install.packages("pak")
pak::pak("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)

Configuration

DESCRIPTION entries

  • Config/build/clean-inst-doc can be set to FALSE to avoid cleaning up inst/doc when building a source package. Set it to TRUE to force a cleanup. See the clean_doc argument of build() as well.

  • Config/build/copy-method can be used to avoid copying large directories in R CMD build. It works by copying (or linking) the files of the package to a temporary directory, leaving out the (possibly large) files that are not part of the package. Possible values:

    • none: pkgbuild does not copy the package tree. This is the default.
    • copy: the package files are copied to a temporary directory before R CMD build.
    • link: the package files are symbolic linked to a temporary directory before R CMD build. Windows does not have symbolic links, so on Windows this is equivalent to copy.

    You can also use the pkg.build_copy_method option or the PKG_BUILD_COPY_METHOD environment variable to set the copy method. The option is consulted first, then the DESCRIPTION entry, then the environment variable.

  • Config/build/extra-sources can be used to define extra source files for pkgbuild to decide whether a package DLL needs to be recompiled in needs_compile(). The syntax is a comma separated list of file names, or globs. (See ?utils::glob2rx().) E.g. src/rust/src/*.rs or configure*.

Options

  • pkg.build_copy_method: use this option to avoid copying large directories when building a package. See possible values above, at the Config/build/copy-method DESCRIPTION entry.

  • pkg.build_extra_flags: set this to FALSE to to opt out from adding debug compiler flags in compile_dll(). Takes precedence over the PKG_BUILD_EXTRA_FLAGS environment variable. Possible values:

    • TRUE: add extra flags,
    • FALSE: do not add extra flags,
    • "missing": add extra flags if the user does not have a $HOME/.R/Makevars file.
  • pkg.build_stop_for_warnings: if it is set to TRUE, then pkgbuild will stop for R CMD build errors. It takes precedence over the PKG_BUILD_STOP_FOR_WARNINGS environment variable.

Environment variables

  • PKG_BUILD_COLOR_DIAGNOSTICS: set it to false to opt out of colored compiler diagnostics. Set it to true to force colored compiler diagnostics.

  • PKG_BUILD_COPY_METHOD: use this environment variable to avoid copying large directories when building a package. See possible values above, at the Config/build/copy-method DESCRIPTION entry.

  • PKG_BUILD_EXTRA_FLAGS: set this to false to to opt out from adding debug compiler flags in compile_dll(). The pkg.build_extra_flags option takes precedence over this environment variable. Possible values:

    • "true": add extra flags,
    • "false": do not add extra flags,
    • "missing": add extra flags if the user does not have a $HOME/.R/Makevars file.
  • PKG_BUILD_STOP_FOR_WARNINGS: if it is set to true, then pkgbuild will stop for R CMD build errors. The pkg.build_stop_for_warnings option takes precedence over this environment variable.

Code of Conduct

Please note that the pkgbuild project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,350
star
2

lintr

Static Code Analysis for R
R
1,145
star
3

httr

httr: a friendly http package for R
R
978
star
4

actions

GitHub Actions for the R community
JavaScript
898
star
5

testthat

An R 📦 to make testing 😀
R
860
star
6

usethis

Set up commonly used 📦 components
R
809
star
7

pkgdown

Generate static html documentation for an R package
R
692
star
8

styler

Non-invasive pretty printing of R code
R
674
star
9

pak

A fresh approach to package installation
C
605
star
10

cli

Tools for making beautiful & useful command line interfaces
R
597
star
11

roxygen2

Generate R package documentation from inline R comments
R
574
star
12

rig

The R Installation Manager
Rust
503
star
13

rlang

Low-level API for programming with R
R
475
star
14

progress

Progress bar in your R terminal
R
450
star
15

R6

Encapsulated object-oriented programming for R
R
398
star
16

here

A simpler way to find your files
R
394
star
17

scales

Tools for ggplot2 scales
R
379
star
18

fs

Provide cross platform file operations based on libuv.
C
356
star
19

covr

Test coverage reports for R
R
327
star
20

rex

Friendly regular expressions for R.
R
323
star
21

crayon

🖍️ R package for colored terminal output — now superseded by cli
R
319
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
313
star
23

memoise

Easy memoisation for R
R
312
star
24

lobstr

Understanding complex R objects with tools similar to str()
R
295
star
25

callr

Call R from R
R
282
star
26

waldo

Find differences between R objects
R
274
star
27

vctrs

Generic programming with typed R vectors
C
273
star
28

slider

Sliding Window Functions
R
272
star
29

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
249
star
30

conflicted

An alternative conflict resolution strategy for R
R
242
star
31

bench

High Precision Timing of R Expressions
R
237
star
32

gmailr

Access the Gmail RESTful API from R.
R
231
star
33

processx

Execute and Control Subprocesses from R
C
227
star
34

asciicast

Turn R scripts into terminal screencasts
R
217
star
35

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
215
star
36

xml2

Bindings to libxml2
R
213
star
37

gh

Minimalistic GitHub API client in R
R
213
star
38

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
188
star
39

keyring

🔐 Access the system credential store from R
R
187
star
40

vdiffr

Visual regression testing and graphical diffing with testthat
C++
178
star
41

svglite

A lightweight svg graphics device for R
C++
177
star
42

pillar

Format columns with colour
R
172
star
43

ragg

Graphic Devices Based on AGG
C++
167
star
44

withr

Methods For Temporarily Modifying Global State
R
166
star
45

hugodown

Make websites with hugo and RMarkdown
R
164
star
46

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
162
star
47

rprojroot

Finding files in project subdirectories
R
147
star
48

coro

Coroutines for R
R
146
star
49

debugme

Easy and efficient debugging for R packages
R
142
star
50

available

Check if a package name is available to use
R
141
star
51

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
139
star
52

ellipsis

Tools for Working with ...
R
138
star
53

gert

Simple git client for R
C
135
star
54

later

Schedule an R function or formula to run after a specified period of time.
C++
134
star
55

itdepends

R
133
star
56

rray

Simple Arrays
R
130
star
57

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
58

fastmap

Fast map implementation for R
C++
128
star
59

prettyunits

Pretty, human readable formatting of quantities
JavaScript
125
star
60

desc

Manipulate DESCRIPTION files
R
121
star
61

tidyselect

A backend for functions taking tidyverse selections
R
120
star
62

gargle

Infrastructure for calling Google APIs from R, including auth
R
111
star
63

rcmdcheck

Run R CMD check from R and collect the results
R
109
star
64

evaluate

A version of eval for R that returns more information about what happened
R
106
star
65

prettycode

Syntax highlight R code in the terminal
R
99
star
66

sloop

S language OOP ⛵️
R
99
star
67

mockery

A mocking library for R.
R
98
star
68

revdepcheck

R package reverse dependency checking
R
95
star
69

clock

A Date-Time Library for R
R
94
star
70

pkgdepends

R Package Dependency Resolution
R
93
star
71

systemfonts

System Native Font Handling in R
C++
91
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
73

gtable

The layout packages that powers ggplot2
R
84
star
74

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
83
star
75

askpass

Password Entry for R, Git, and SSH
R
82
star
76

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
77

zip

Platform independent zip compression via miniz
C
81
star
78

tree-sitter-r

C
81
star
79

downlit

Syntax Highlighting and Automatic Linking
R
80
star
80

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
75
star
81

sessioninfo

Print Session Information
R
72
star
82

ps

R package to query, list, manipulate system processes
C
71
star
83

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
84

credentials

Tools for Managing SSH and Git Credentials
R
69
star
85

roxygen2md

Convert elements of roxygen documentation to markdown
R
68
star
86

sodium

R bindings to libsodium
R
66
star
87

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
65
star
88

cliapp

Rich Command Line Applications
R
61
star
89

webfakes

Fake web apps for HTTP testing R packages
C
60
star
90

generics

Common generic methods
R
58
star
91

diffviewer

HTML widget to visually compare files
JavaScript
56
star
92

liteq

Serverless R message queue using SQLite
R
56
star
93

pkgload

Simulate installing and loading a package
R
54
star
94

cachem

Key-value caches for R
R
53
star
95

carrier

Create standalone functions for remote execution
R
50
star
96

brio

Basic R Input Output
R
50
star
97

jose

Javascript Object Signing and Encryption for R
R
48
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
45
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star