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
TRUEandtable_nameisNULL, also prints a breakdown by dataset. Defaults toFALSE.- source
Character. The data family:
"core"(default for a table lookup),"nom","sim","comp","conj"(conjoint experiments; seeirw_conj_long), or"rank"(rankings; seeirw_rank_compress). Omit it with notable_namefor every family at once.- comp
Deprecated. Use
source = "comp"instead.- sim
Deprecated. Use
source = "sim"instead.- nom
Deprecated. Use
source = "nom"instead.
Details
If table_name and source are both omitted, shows the table count
and size of every data family, with totals across them. Name a source
to see one family on its own. Use details = TRUE to also print a
per-dataset breakdown (main IRW only). If a table name is provided, shows
details for that table, looked up in source.
Examples
if (FALSE) { # irw_has_credentials() || nzchar(Sys.getenv("IRW_RUN_EXAMPLES"))
# \donttest{
irw_info() # Every data family, with totals
irw_info(source = "core") # The main IRW datasets only
irw_info(details = TRUE) # Every family + per-dataset breakdown of core
irw_info("frac20") # Specific IRW table
irw_info("t20_hyper", source = "comp") # Competition table
irw_info("gilbert_meta_3", source = "sim")
# }
}