Show model lineage and relationships.

With no arguments, returns the full project lineage tree. Supplying a model path returns that model's full lineage (ancestors and descendants). The from and to arguments filter the tree from a model downward, up to a model, or to the slice between two models. The project is always rooted at the directory containing pharos.toml.

Usage

get_model_lineage(model = NULL, from = NULL, to = NULL, verbose = FALSE)

get_model_lineage(model = NULL, from = NULL, to = NULL, verbose = FALSE)

Arguments

model

Optional hyperion_nonmem_model object or model file path. Returns the model's full lineage (ancestors and descendants). Conflicts with from/to.

from

Filter the tree to this model and everything downstream. Accepts a hyperion_nonmem_model object or a model file path.

to

Filter the tree to this model and everything upstream. Accepts a hyperion_nonmem_model object or a model file path.

verbose

Logical; if TRUE, the returned tree carries a "verbose" attribute that causes print() and knit_print() to render a flat 6-column table (Model, Parent, Description, Tags, Model Hash, Dataset Hash) instead of the tree view.

Value

hyperion_nonmem_tree S3 object

Examples

if (FALSE) { # \dontrun{
get_model_lineage()                                            # whole project
get_model_lineage("model/nonmem/run003.mod")                   # full lineage of run003
get_model_lineage(from = "model/nonmem/run001.mod")            # run001 and descendants
get_model_lineage(to = "model/nonmem/run003.mod")              # run003 and ancestors
get_model_lineage(from = "model/nonmem/run001.mod",
                  to   = "model/nonmem/run003.mod")            # slice between two models
} # }