collect_n_subject {metalite}

Collect number of subjects and its subset condition

Description

Collect number of subjects and its subset condition

Usage

collect_n_subject(
  meta,
  population,
  parameter,
  listing = FALSE,
  histogram = FALSE,
  var_listing = NULL,
  remove_blank_group = FALSE,
  type = "Subjects",
  use_na = c("ifany", "no", "always"),
  display_total = TRUE
)

Arguments

meta

A meta_adam object.

population

A character value of population term name. The term name is used as key to link information.

parameter

A character value of parameter term name. The term name is used as key to link information.

listing

A logical value to display drill down listing per row.

histogram

A logical value to display histogram by group.

var_listing

A character vector of additional variables included in the listing.

remove_blank_group

A logical value to remove a group with all missing value of a parameter.

type

A character value to control title name, e.g., Subjects or Records.

use_na

A character value for whether to include NA values in the table. See the useNA argument in base::table() for more details.

display_total

A logical value to display total column.

Value

A list containing number of subjects and its subset condition.

Examples

suppressWarnings(
  meta <- meta_example() |>
    define_parameter(name = "sex", var = "SEX", label = "Sex")
)
collect_n_subject(meta, "apat", "sex")