Package: Require 2.0.0.9036

Eliot J B McIntire

Require: Installing and Loading R Packages for Reproducible Workflows

A single key function, 'Require' that makes rerun-tolerant versions of 'install.packages' and 'require' for CRAN packages, packages no longer on CRAN (i.e., archived), specific versions of packages, and GitHub packages. This approach is developed to create reproducible workflows that are flexible and fast enough to use while in development stages, while able to build snapshots once a stable package collection is found. As with other functions in a reproducible workflow, this package emphasizes functions that return the same result whether it is the first or subsequent times running the function, with subsequent times being sufficiently fast that they can be run every time without undue waiting burden on the user or developer.

Authors:Eliot J B McIntire [aut, cre], Alex M Chubaty [ctb], His Majesty the King in Right of Canada, as represented by the Minister of Natural Resources Canada [cph]

Require_2.0.0.9036.tar.gz
Require_2.0.0.9036.zip(r-4.7)Require_2.0.0.9036.zip(r-4.6)Require_2.0.0.9036.zip(r-4.5)
Require_2.0.0.9036.tgz(r-4.6-any)Require_2.0.0.9036.tgz(r-4.5-any)
Require_2.0.0.9036.tar.gz(r-4.7-any)Require_2.0.0.9036.tar.gz(r-4.6-any)
Require_2.0.0.9036.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
Require/json (API)

# Install 'Require' in R:

install.packages('Require', repos = c('https://predictiveecology.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/predictiveecology/require/issues

Pkgdown/docs site:https://require.predictiveecology.org

On CRAN:

10.18 score 24 stars 14 packages 179 scripts 2.2k downloads 47 exports 8 dependencies

Last updated from:0473223cdf (on development). Checks:9 OK. Indexed: yes.

Target	Result	Time
linux-devel-x86_64	OK	1085
source / vignettes	OK	204
linux-release-x86_64	OK	1041
macos-release-arm64	OK	207
macos-oldrel-arm64	OK	197
windows-devel	OK	309
windows-release	OK	259
windows-oldrel	OK	228
wasm-release	OK	105

Exports:.downloadFileMasterMainAuth cacheClearPackages cacheDefaultDir cacheDir cacheGetOptionCachePkgDir cachePkgDir cachePurge checkPath clearRequirePackageCache compareVersion2 detachAll dlArchiveVersionsAvailable dlGitHubDESCRIPTION extractInequality extractPkgGitHub extractPkgName extractVersionNumber getCRANrepos getRequireOptions Install invertList messageDF messageVerbose modifyList2 modifyList3 normPath paddedFloatToChar parseGitHub pkgDep pkgDep2 pkgDepIfDepRemoved pkgDepTopoSort pkgSnapshot pkgSnapshot2 purgeCache Require RequireOptions setdiffNamed setLibPaths setLinuxBinaryRepo setup setupOff sourcePkgs tempdir2 tempfile2 trimVersionNumber updatePackages

Dependencies:callr data.table otel pak processx ps R6 sys

The Require approach, comparing pak and renv

Rendered fromRequire.Rmdusingknitr::rmarkdown

Last update: 2026-05-14
Started: 2024-07-26

Help page	Topics
Require: Installing and Loading R Packages for Reproducible Workflows	Require-package Install Require
GITHUB_PAT-aware and 'main'-'master'-aware download from GitHub	.downloadFileMasterMainAuth
Partial alternative (faster) to 'installed.packages'	.installed.pkgs
Create a custom "available.packages" object	availablePackagesOverride
Needs 'VersionOnRepos', 'versionSpec' and 'inequality' columns	availableVersionOK
Clear cached package tarballs	cacheClearPackages clearRequirePackageCache
The default cache directory for Require Cache	cacheDefaultDir
Path to (package) cache directory	cacheDir cachePkgDir
Get the option for 'Require.cachePkgDir' (deprecated)	cacheGetOptionCachePkgDir
Purge everything in the Require cache	cachePurge purgeCache
Creates the directories, and adds version number	checkLibPaths
Check directory path	checkPath checkPath,character,logical-method checkPath,character,missing-method checkPath,missing,ANY-method checkPath,NULL,ANY-method
Compare package versions	compareVersion2
Only checks for deprecated libPath argument (singular)	dealWithMissingLibPaths
GitHub package tools	DESCRIPTIONFileOtherV DESCRIPTIONFileVersionV dlGitHubDESCRIPTION
Detach and unload all packages	detachAll
Available and archived versions	available.packagesCached dlArchiveVersionsAvailable
Deals with missing libPaths arg, and takes first	doLibPaths
1st level -> create the .pkgEnv object in Require	envPkgCreate
3rd level for deps #############################################	envPkgDepDepsCreate
3rd level for DESCRIPTIONFile	envPkgDepDESCFileCreate
Extract info from package character strings	extractInequality extractPkgGitHub extractPkgName extractVersionNumber
The 'packages' argument may have up to 4 pieces of information for GitHub packages: name, repository, branch, version. For CRAN-alikes, it will only be 2 pieces: name, version. There can also be an inequality or equality, if there is a version.	getDeps
Internet Exists query	internetExists
Invert a 2-level list	invertList
Join a data.table with a 'Package' column to 'available.packages'	joinToAvailablePackages
Create link to file, falling back to making a copy if linking fails.	fileRenameOrMove linkOrCopy
This converts master or main to HEAD for a git repo	masterMainToHead
Use message to print a clean square data structure	messageDF messageVerbose messageVerboseCounter
'modifyList' for multiple lists	modifyList2 modifyList3
Normalize filepath	normPath normPath,character-method normPath,list-method normPath,logical-method normPath,missing-method normPath,NULL-method
Convert numeric to character with padding	paddedFloatToChar
2nd level	pakEnv
Parse a github package specification	parseGitHub
2nd level	pkgDepEnv
Package dependencies when one or more packages removed	pkgDepIfDepRemoved
Reverse package depends	pkgDep pkgDep2 pkgDepTopoSort
Take a snapshot of all the packages and version numbers	pkgSnapshot pkgSnapshot2
'Require' options	getRequireOptions RequireOptions
Recursive function to remove '.basePkgs'	rmBase
R versions	rversions
Like 'setdiff', but takes into account names	setdiffNamed
Set '.libPaths'	setLibPaths
Setup for binary Linux repositories	setLinuxBinaryRepo
Setup a project library, cache, options	setup setupOff
A list of R packages that should likely be installed from Source, not Binary	sourcePkgs
'split' for a data.table that keeps integrity of a column of lists of data.table objects	splitKeepOrderAndDTIntegrity
download.files or install.packages in a separate process	sysInstallAndDownload
Make a temporary (sub-)directory	tempdir2
Make a temporary subfile in a temporary (sub-)directory	tempfile2
Trim version number off a compound package name	trimVersionNumber
Update installed packages with latest available versions	updatePackages

Package: Require 2.0.0.9036

Require: Installing and Loading R Packages for Reproducible Workflows

Citation

Development and contributors

Readme and manuals

Help Manual

Usage by other packages (reverse dependencies)