Variables in a Multimedia Object — retrieve

This returns all the variables modeled within a multimedia object. This can be helpful for overviewing an experiment and is called by the print methods in this package. Also supports filtering to specific node types, e.g., mediators.

Usage

retrieve_names(object, nm)

Arguments

object: An object of class multimedia
nm: A string specifying the node type to filter down to, e.g., 'treatment' or 'mediator'.

Value

A character vector containing all the names of the variables of the node type nm.

Examples

exper <- demo_joy() |>
    mediation_data("PHQ", "treatment", starts_with("ASV"))
multimedia(exper) |>
    retrieve_names("mediator")
#> [1] "ASV1" "ASV2" "ASV3" "ASV4" "ASV5"