Skip to contents

Retrieve and Print IRW Database or Table Information

Source: R/explore.R
irw_info.Rd

Prints information about the IRW datasets or a specific table.

Usage

irw_info(
  table_name = NULL,
  details = FALSE,
  source = "core",
  comp = FALSE,
  sim = FALSE,
  nom = FALSE
)

Arguments

table_name

Optional. Table name to describe; if NULL, prints database‑level info.

details

Logical. When TRUE and table_name is NULL, also prints a breakdown by dataset. Defaults to FALSE.

source

Character. Data source: "core" (default), "nom", "sim", or "comp".

comp

Deprecated. Use source = "comp" instead.

sim

Deprecated. Use source = "sim" instead.

nom

Deprecated. Use source = "nom" instead.

Value

Invisibly returns NULL.

Details

If table_name is NULL, shows combined totals across all IRW datasets. Use details = TRUE to also print a per-dataset breakdown (main IRW only). If a table name is provided, shows details for that table.

Examples

if (FALSE) { # \dontrun{
irw_info()                 # Combined totals
irw_info(details = TRUE)   # Combined + per-dataset breakdown
irw_info("frac20")      # Specific IRW table
irw_info("t20_hyper", source = "comp")  # Competition table
irw_info("gilbert_meta_3", source = "sim")

} # }