Sigma parameter comment class — SigmaComment • hyperion

Represents parsed comments for SIGMA parameters.

Usage

SigmaComment(
  nonmem_name = character(0),
  name = NULL,
  display = NULL,
  description = NULL,
  unit = NULL,
  parameterization = NULL
)

Arguments

nonmem_name: Character. The NONMEM parameter name (e.g., "SIGMA(1,1)").
name: Character or NULL. User-defined parameter name (e.g., "PropErr").
display: Character or NULL. Display name for tables/output.
description: Character or NULL. Description of the parameter.
unit: Character or NULL. Unit of measurement (e.g., "ng/mL").
parameterization: Character or NULL. Transformation type.

Properties

nonmem_name: The NONMEM parameter identifier.
name: User-friendly name parsed from comments.
display: Display name for tables. Falls back to name if NULL.
description: Longer description of what the parameter represents.
parameterization: Transformation type. Valid values: "LogNormal", "Logit", "AddErr", "LogAddErr", "Proportional", "Identity".