read_cargo_metadata: Retrieve metadata for packages and workspaces

View source: R/read_cargo_metadata.R

read_cargo_metadataR Documentation

Retrieve metadata for packages and workspaces

Description

Retrieve metadata for packages and workspaces

Usage

read_cargo_metadata(path = ".", dependencies = FALSE, echo = FALSE)

Arguments

path

character scalar, the R package directory

dependencies

Default FALSE. A logical scalar, whether to include all recursive dependencies in stdout.

echo

Default FALSE. A logical scalar, should cargo command and outputs be printed to the console.

Details

For more details, see Cargo docs for cargo-metadata. See especially "JSON Format" to get a sense of what you can expect to find in the returned list.

Value

A list including the following elements:

  • packages

  • workspace_members

  • workspace_default_members

  • resolve

  • target_directory

  • version

  • workspace_root

  • metadata

Examples

## Not run: 
read_cargo_metadata()

## End(Not run)


extendr/rextendr documentation built on April 5, 2025, 1:53 a.m.