Omega parameter comment class — OmegaComment • hyperion

Represents parsed comments for OMEGA parameters.

Usage

OmegaComment(
  nonmem_name = character(0),
  name = NULL,
  display = NULL,
  description = NULL,
  parameterization = NULL,
  associated_theta = NULL
)

Arguments

nonmem_name: Character. The NONMEM parameter name (e.g., "OMEGA(1,1)").
name: Character or NULL. User-defined parameter name (e.g., "IIV-CL").
display: Character or NULL. Display name for tables/output.
description: Character or NULL. Description of the parameter.
parameterization: Character or NULL. Transformation type.
associated_theta: Character vector or NULL. Related theta name(s).

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".
associated_theta: Related theta parameter(s). For diagonal elements, typically a single name (e.g., "CL"). For off-diagonal (covariance), multiple names (e.g., c("CL", "V")).