neuroc_desc: Neuroc DESCRIPTION File

View source: R/neuroc_desc.R

neuroc_descR Documentation

Neuroc DESCRIPTION File

Description

Neuroc DESCRIPTION File

Usage

neuroc_desc(
  path = "DESCRIPTION",
  table_path = NULL,
  release = c("stable", "current"),
  dev = FALSE,
  verbose = TRUE,
  user = NULL,
  deployment = FALSE,
  force = deployment,
  fix_remotes = TRUE,
  ...
)

Arguments

path

path to DESCRIPTION file

table_path

Path to the table of packages for neuroconductor

release

Stable or development version

dev

Development Site vs. not?

verbose

print diagnostic messages

user

GitHub username for repos

deployment

indicator if this is a release, not standard running. Just deployment.

force

should this stop (FALSE) on missing DESCRIPTION files? Passed to get_repo_dep_mat.

fix_remotes

Run fix_desc_remotes on the DESCRIPTION file before running.

...

arguments to pass to neuroc_install_order.

Details

The function will parse a description, delete any remotes for packages in neuroconductor, add the neuroconductor remotes (in order), adds biocViews field (for Travis), puts the covr in Suggests for code coverage if not already in Imports/Suggests/Depends, replaces the SystemRequirements field with the suggested value(s) from https://goo.gl/x7rcCD

Value

Path to new DESCRIPTION file


muschellij2/neuroc.deps documentation built on June 9, 2025, 5:19 p.m.