Package {manifesto}

Title:	Create Project Manifest Files
Version:	0.0.2
Description:	Provides 'TOML' representations of packages needed that must be installed to run a project. Includes functions to specify detailed installation functions, validate files, and to use a given file as the requirements for a project. Handles package installations, when necessary, via 'pak'.
License:	MIT + file LICENSE
Encoding:	UTF-8
RoxygenNote:	7.3.3
Imports:	cli, jsonlite, pak, tomledit
URL:	https://github.com/christopherkenny/manifesto, http://christophertkenny.com/manifesto/
BugReports:	https://github.com/christopherkenny/manifesto/issues
Suggests:	knitr, rmarkdown, testthat (≥ 3.0.0)
Config/testthat/edition:	3
Config/Needs/website:	christopherkenny/ctktemplate
VignetteBuilder:	knitr
Depends:	R (≥ 4.2.0)
NeedsCompilation:	no
Packaged:	2026-05-01 16:33:21 UTC; chris
Author:	Christopher T. Kenny [aut, cre]
Maintainer:	Christopher T. Kenny <ctkenny@proton.me>
Repository:	CRAN
Date/Publication:	2026-05-05 18:10:02 UTC

Get the current R version

Description

The version is returned as a string in the format "major.minor.patch" (e.g., "4.4.0"), using components from R.version.

Usage

current_r_version()

Value

A character string representing the full R version.

Examples

current_r_version()

Return all defined optional dependency groups in a manifest file

Description

Return all defined optional dependency groups in a manifest file

Usage

manifest_all_groups(path = "rproject.toml")

Arguments

Value

A character vector of group names (without "-dependencies")

Examples

manifest_all_groups(path = system.file(package = 'manifesto', 'minimal.toml'))

Check if the installed packages match the manifest requirements

Description

Check if the installed packages match the manifest requirements

Usage

manifest_check(path = "rproject.toml", groups = NULL)

Arguments

Value

A data.frame reporting installed version, required version, and status.

Examples

manifest_check(system.file(package = 'manifesto', 'minimal.toml'))

Check for system dependencies

Description

This function checks for the presence of system dependencies listed in the ⁠[system-dependencies]⁠ section of the manifest file.

Usage

manifest_check_system(path = "rproject.toml")

Arguments

Value

A data.frame reporting the system dependency, and its status.

Examples

path <- manifest_create(`system-dependencies` = list(git = '*'))
manifest_check_system(path)

Create a minimal TOML manifest file

Description

This creates a minimal TOML file with a ⁠[manifesto]⁠, ⁠[project]⁠, ⁠[environment]⁠, and empty ⁠[dependencies]⁠ section.

Usage

manifest_create(
  path,
  project_name = "Project",
  project_version = "0.0.1",
  manifesto_version = manifest_version(),
  r_version = "*",
  ...
)

Arguments

Value

Invisibly returns the written path.

Examples

path <- manifest_create(
  dependencies = list(dplyr = '>= 1.0.0'),
  'suggests-dependencies' = list(testthat = '>= 3.0.0')
)

Generate a TOML manifest from a DESCRIPTION file

Description

Parses fields from a DESCRIPTION file and generates a corresponding TOML manifest with ⁠[project]⁠, ⁠[environment]⁠, and dependency groups.

Usage

manifest_from_description(
  description = "DESCRIPTION",
  path,
  include_empty_groups = FALSE
)

Arguments

Details

By default, both Depends and Imports are mapped to ⁠[dependencies]⁠. Suggests, LinkingTo, and Enhances are mapped to their own optional groups.

Value

Path to the generated TOML file (invisibly).

Examples

path <- manifest_from_description(system.file(package = 'cli', 'DESCRIPTION'))

Generate a TOML manifest from installed packages

Description

Captures all packages installed on .libPaths() and generates a manifesto-style TOML manifest. Package versions can either reflect their installed versions, or use a wildcard (*) to accept any.

Usage

manifest_from_installed(
  path,
  include_base = FALSE,
  min_version = c("installed", "*"),
  r_version = current_r_version()
)

Arguments

Details

Base packages are excluded by default to minimize boilerplate.

Value

Path to the generated TOML file (invisibly).

Examples

path <- manifest_from_installed()

Generate a TOML manifest from currently loaded packages

Description

Captures all currently loaded packages in the R session and generates a manifesto-style TOML manifest. Package versions can either reflect their current loaded versions, or use a wildcard (*) to accept any.

Usage

manifest_from_loaded(
  path,
  include_base = FALSE,
  min_version = c("loaded", "*"),
  r_version = current_r_version()
)

Arguments

Details

Base packages are excluded by default to minimize boilerplate.

Value

Path to the generated TOML file (invisibly).

Examples

path <- manifest_from_loaded()

Generate a TOML manifest from a pak lockfile

Description

Reads a {pak} lockfile (JSON format) and converts it to a manifesto-style TOML manifest. Extracts package versions and the locked R version.

Usage

manifest_from_pak(lockfile = "pkg.lock", path, r_version)

Arguments

Value

Path to the generated TOML file (invisibly).

Examples

path <- manifest_from_pak(system.file(package = 'manifesto', 'pkg.lock'))

Generate a TOML manifest from a renv lockfile

Description

Reads a {renv} lockfile (JSON format) and converts it to a manifesto-style TOML manifest. Extracts package versions and the R environment version.

Usage

manifest_from_renv(lockfile = "renv.lock", path, r_version)

Arguments

Value

Path to the generated TOML file (invisibly).

Examples

path <- manifest_from_renv(system.file(package = 'manifesto', 'renv.lock'))

Install packages from a manifesto manifest

Description

Install packages from a manifesto manifest

Usage

manifest_install(path = "rproject.toml", groups = NULL, dry_run = FALSE)

Arguments

Value

Invisibly returns a character vector of package references that were installed.

Examples

manifest_install(
  path = system.file(package = 'manifesto', 'minimal.toml'),
  dry_run = TRUE
)

Parse a manifesto manifest file

Description

By default, groups = NULL, which will only install core dependencies. If you want to include all optional groups, set groups = 'all'.

Usage

manifest_parse(path = "rproject.toml", groups = NULL)

Arguments

Value

A character vector of resolved package references.

Examples

manifest_parse(path = system.file(package = 'manifesto', 'minimal.toml'))

Peek into a manifest file

Description

Peek into a manifest file

Usage

manifest_peek(path = "rproject.toml")

Arguments

Value

Invisibly returns a list with parsed contents.

Examples

manifest_peek(system.file('complex.toml', package = 'manifesto'))

Convert a TOML manifest to a DESCRIPTION file

Description

Generates a valid DESCRIPTION file from a manifest. Required fields like Title, Description, License, and Authors@R are inserted as TODOs if not present.

Usage

manifest_to_description(path = "rproject.toml", out = "DESCRIPTION")

Arguments

Value

Invisibly returns the path to the written DESCRIPTION file.

Examples

out <- tempfile(pattern = 'DESCRIPTION')
manifest_to_description(
  path = system.file('minimal.toml', package = 'manifesto'),
  out = out
)

Validate a manifesto manifest file

Description

Validate a manifesto manifest file

Usage

manifest_validate(path = "rproject.toml", groups = NULL)

Arguments

Value

Invisibly returns TRUE if the manifest is valid; otherwise, stops with an error.

Examples

manifest_validate(path = system.file(package = 'manifesto', 'minimal.toml'))

Return the current version of the manifesto package

Description

Return the current version of the manifesto package

Usage

manifest_version()

Value

A character version string.

Examples

manifest_version()