R/meta_forestly.R

In elong0527/forestly: Interactive Forest Plot

#' Create metadata for interactive forest plot
#'
#' @param dataset_adsl ADSL source dataset.
#' @param dataset_adae ADAE source dataset.
#' @param population_term A character value of population term name.
#' @param population_subset An unquoted condition for selecting the
#'   populations from ADSL dataset.
#' @param observation_term A character value of observation term name.
#' @param observation_subset An unquoted condition for selecting the
#'   observations from ADAE dataset.
#' @param parameter_term A character value of parameter term name.
#'
#' @return A metalite object.
#'
#' @export
#'
#' @examples
#' meta_forestly(
#'   forestly_adsl,
#'   forestly_adae,
#'   population_term = "apat",
#'   observation_term = "wk12"
#' )
meta_forestly <- function(
    dataset_adsl,
    dataset_adae,
    population_term,
    population_subset = SAFFL == "Y",
    observation_term,
    observation_subset = SAFFL == "Y",
    parameter_term = "any;rel;ser") {
  meta <- metalite::meta_adam(
    population = dataset_adsl,
    observation = dataset_adae
  ) |>
    metalite::define_plan(plan = metalite::plan(
      analysis = "ae_forestly",
      population = population_term,
      observation = observation_term,
      parameter = parameter_term
    )) |>
    metalite::define_population(
      name = population_term,
      group = "TRTA",
      subset = !!rlang::enquo(population_subset),
      label = ""
    ) |>
    metalite::define_observation(
      name = observation_term,
      group = "TRTA",
      subset = !!rlang::enquo(observation_subset),
      label = ""
    )

  meta <- meta |>
    metalite::define_analysis(
      name = "ae_forestly",
      label = "Interactive forest plot"
    ) |>
    metalite::meta_build()

  meta
}