Retrieves a summary of available tables in the IRW database, including their name,
number of rows, and variable count, sorted alphabetically by table name.
Usage
irw_list_tables(sim = FALSE, comp = FALSE)
Arguments
- sim
Logical. If TRUE, lists tables from the IRW simulation dataset (irw_simsyn).
- comp
Logical. If TRUE, lists tables from the IRW competition dataset (irw_comp).
If both sim and comp are FALSE (default), lists tables from the main IRW database.
Only one of sim or comp should be TRUE at a time.
Value
A data frame with the following columns:
- name
The name of the table, sorted alphabetically.
- numRows
The number of rows in the table.
- variableCount
The number of variables in the table.
Examples
if (FALSE) { # \dontrun{
irw_list_tables() # Main IRW database
irw_list_tables(sim = TRUE) # Simulation dataset
irw_list_tables(comp = TRUE) # Competition dataset
} # }