List IRW Collections

Returns the collection registry: one row per collection, with its kind, definition, the rule that produced it, and how complete its coverage is.

Usage

irw_collections(kind = NULL)

Arguments

kind

Optional character vector. Filter to "design", "instrument" and/or "construct".

Value

A tibble, one row per collection.

Details

Collections are labelled groupings of IRW tables — study designs (rct, clustered, q_matrix), instrument families (big_five, promis) and constructs (depression, math). A table can belong to any number of them.

Coverage

coverage says how much of the warehouse the collection's rule actually searched, and it matters when you need "all" of something:

metadata-complete

The rule read irw_metadata(), so it saw every documented table. Note this is not the same as the whole warehouse — irw_metadata() itself has gaps.

tagged-subset-only

The rule read the tags table, which covers roughly 62% of documented tables, and coverage is much lower in the newer warehouses. These collections are biased toward older tables and should not be described as exhaustive.

curated-only

Every member was chosen by hand.

See also

irw_collection(), irw_collection_members(), irw_filter()

Examples

if (FALSE) { # \dontrun{
irw_collections()
irw_collections(kind = "instrument")
} # }