pkg_description_yml: Parse Description 'YAML'

In jeksterslabds/jeksterslabRpkg: Package Utility Functions

Description

Parse Description YAML

Usage

pkg_description_yml(
  input_file = NULL,
  fields = c("Package", "Given", "Family", "Email", "ORCID", "Version", "Title",
    "Description", "License", "Github", "Encoding", "Language", "LazyData",
    "VignetteBuilder", "Roxygen"),
  required = TRUE,
  dependencies = TRUE
)

Arguments

input_file	Character string. YAML file containing DESCRIPTION fields and entries.
fields	Character vector. Fields from DESCRIPTION.yml to extract. Note that this only works for fields that contain a single value.
required	Logical. Check required fields.
dependencies	Logical. Extract dependencies (SystemRequirements, Depends, Imports, Suggests).

Examples

## Not run: 
pkg_description_yml(
  input_file = "DESCRIPTION.yml",
  fields = c(
    "Package",
    "Given",
    "Family",
    "Email",
    "ORCID",
    "Version",
    "Title",
    "Description",
    "License",
    "Github",
    "Encoding",
    "Language",
    "LazyData",
    "VignetteBuilder",
    "Roxygen"
  ),
  required = TRUE,
  dependencies = TRUE
)

## End(Not run)

jeksterslabds/jeksterslabRpkg documentation built on Jan. 22, 2021, 11:43 p.m.