Skip to contents

This function creates a metadata file that stores information about a NONMEM model, including its description, tags, and lineage information. The metadata is stored in a structured format that can be used for model tracking and documentation.

Usage

set_metadata_file(
  model_path,
  description = NULL,
  tags = NULL,
  based_on = NULL,
  copied_from = NULL
)

Arguments

model_path

Path to the NONMEM model file, or a hyperion_nonmem_model object (required)

description

Optional description of the model and its purpose

tags

Character vector of tags to categorize or label the model

based_on

Character vector of model names/paths that this model is based on

copied_from

Optional model name/path this model was mechanically copied from

Value

The model's updated metadata, as returned by get_model_metadata()

Examples

if (FALSE) { # \dontrun{
# Create basic metadata for a model
set_metadata_file("run001.mod", description = "Base population PK model")

# Create metadata using a model object
model <- read_model("run001.mod")
set_metadata_file(model, description = "Base population PK model")

# Create metadata with tags and lineage
set_metadata_file(
  "run002.mod",
  description = "PK model with covariate effects",
  tags = c("population", "pk", "covariates"),
  based_on = c("run001.mod")
)
} # }