Package 'deps'

Title: Dependency Management with 'roxygen'-Style Comments
Description: Manage your source code dependencies by decorating your existing R code with special, 'roxygen'-style comments.
Authors: Peter Solymos [aut, cre] , Analythium Solutions Inc. [cph, fnd]
Maintainer: Peter Solymos <[email protected]>
License: MIT + file LICENSE
Version: 0.4.0
Built: 2024-12-04 04:26:08 UTC
Source: https://github.com/analythium/deps

Help Index

Create a Dependencies JSON File

Description

Discover dependencies and write a dependencies.json file.

Usage

create(
  dir = getwd(),
  file = "dependencies.json",
  output = dir,
  installed = c("base", "recommended"),
  overwrite = TRUE,
  ask = TRUE
)

Arguments

dir

Path to the directory where the files to be scanned are located.
file

The name of the file to be save, default is "dependencies.json".
output

Path to the directory where JSON file should be written to.
installed

The priority argument for installed.packages() for packages to be excluded.
overwrite

Logical, should the file in the output directory be overwritten if exists?
ask

Logical, asking confirmation before writing the dependencies.json file.

Value

Invisibly returns the list of file names that were created. The side effect is a JSON (and possibly a text for system requirements) file written to the hard drive. The function fails when there are no R related files in dir.

Examples

dir <- system.file("examples/01-basic", package = "deps")
out <- tempdir()
create(dir, output = out, ask = interactive())
cat(readLines(file.path(out, "dependencies.json")), sep = "\n")
unlink(file.path(out, "dependencies.json"))

Install Dependencies

Description

Install dependencies from an existing dependencies.json file or after discovering the dependencies.

Usage

install(
  dir = getwd(),
  file = "dependencies.json",
  upgrade = "never",
  cleanup = TRUE,
  timeout = 300L,
  ask = TRUE,
  ...
)

Arguments

dir

Path to the directory where the JSON file should be written to.
file

The name of the file to be save, default is "dependencies.json". If the file is not found in dir, create() is called.
upgrade

Should package dependencies be upgraded? Argument passed to remotes functions.
cleanup

Logical, clean up files created by create() when file does not exist.
timeout

Integer, timeout for file downloads (default 60 seconds can be short).
ask

Logical, asking confirmation before writing the dependencies.json file.
...

Other argument passed to remotes functions.

Value

Returns NULL invisibly. The side effect is the dependencies installed.

Examples

dir <- system.file("examples/01-basic", package = "deps")
out <- tempdir()
create(dir, output = out, ask = interactive())
cat(readLines(file.path(out, "dependencies.json")), sep = "\n")
## Not run: 
install(out)

## End(Not run)
unlink(file.path(out, "dependencies.json"))