ruminate (version 0.3.1)

NCA_fetch_np_meta: Fetches NCA Parameter Meta Information

Description

This provides meta information about NCA parameters. This includes parameter names, text descriptions, formatting (md and LaTeX).

Usage

NCA_fetch_np_meta(
  MOD_yaml_file = system.file(package = "ruminate", "templates", "NCA.yaml")
)

Value

List with the following elements:

• choices: List parameter choices grouped by values specified in the module configuration file.

• summary: Data frame with meta data about the NCA parameters with the following columns:

  • parameter: Name of parameter in PKNCA.

  • text: Name of parameter in plain text.

  • md: Parameter name formatted in Markdown.

  • latex: Parameter name formatted using LaTeX.

  • description: Verbose description in plain text for the parameter.

Arguments

MOD_yaml_file

Module configuration file with MC as main section.

Examples

NCA_fetch_np_meta()