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), exact instruments (phq9, gad7, rses, ...) 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 construct name tag, which is filled for only about half of documented tables, unevenly across the warehouses — and NOT by age: in October 2026 the newest shard was 100% covered and the thinnest was shard 3 at 26%. The definition states the exact count searched. These collections should not be described as exhaustive, and collections.html on the site reports the current spread.
curated-only: Every member was chosen by hand. The exact-instrument collections are of this kind; see irw_collection_members() for how each of their members was identified.

Examples

if (FALSE) { # irw_has_credentials() || nzchar(Sys.getenv("IRW_RUN_EXAMPLES"))
# \donttest{
irw_collections()
irw_collections(kind = "instrument")
# }
}