List available neuromaps annotations — neuromaps

Query the neuromaps registry to see which brain map annotations are available for download. Data is fetched from the neuromaps project's GitHub repository and cached for the session.

Usage

neuromaps_available(
  source = NULL,
  desc = NULL,
  space = NULL,
  density = NULL,
  resolution = NULL,
  hemisphere = NULL,
  tags = NULL,
  format = NULL,
  refresh = FALSE,
  fixed = FALSE
)

Arguments

source: Data source identifier (e.g. "abagen", "beliveau").
desc: Map descriptor key (e.g. "genepc1", "feobv").
space: Coordinate space (e.g. "fsaverage", "MNI152", "fsLR").
density: Surface vertex density (e.g. "10k", "164k"). Mutually exclusive with resolution.
resolution: Volume voxel resolution (e.g. "1mm", "2mm"). Mutually exclusive with density.
hemisphere: Hemisphere ("L" or "R").
tags: Character vector of tags. All must match (AND logic).
format: Filter by format ("surface" or "volume").
refresh: Logical. If TRUE, forces a fresh download of the registry data, ignoring any session cache.
fixed: Logical. If TRUE, filter strings are matched literally rather than as regular expressions.

Value

A tibble of available annotations with columns: source, desc, space, den, res, hemi, format, fname, full_desc, tags, N, age.

Details

All string filter parameters (source, desc, space, density, resolution, hemisphere, format) are treated as R regular expressions and matched with grepl(). For example, source = "^beliveau$" matches exactly, while source = "bel" matches any source containing "bel". Set fixed = TRUE for literal string matching. The tags parameter always uses exact matching (AND logic).

When used in fetch_neuromaps_annotation(), source, desc, and space are exact matches.

Examples

if (FALSE) { # interactive()
neuromaps_available()
neuromaps_available(source = "beliveau")
neuromaps_available(tags = "pet")
}