neuprint_ROIs: Get a vector of all the ROIs in a specified dataset

View source: R/info.R

neuprint_ROIsR Documentation

Get a vector of all the ROIs in a specified dataset

Description

Get the regions of interest (ROIs) used in a neuPrint project

Usage

neuprint_ROIs(
  superLevel = FALSE,
  dataset = NULL,
  fromNeuronFields = FALSE,
  conn = NULL,
  ...
)

Arguments

superLevel

whether not to show 'superlevel' ROIs - ROIs composed of other ROIs. If set to NULL, both low-level and superlevel ROIs are returned.

dataset

optional, a dataset you want to query. If NULL, the default specified by your R environ file is used or, failing that the current connection, is used. See neuprint_login for details.

fromNeuronFields

: Whether to use fields of :Neuron nodes to fetch the ROIs. If FALSE (the default), use the dataset metadata instead. If TRUE, the superLevel argument is ignored

conn

optional, a neuprintr connection object, which also specifies the neuPrint server. If NULL, the defaults set in your .Rprofile or .Renviron are used. See neuprint_login for details.

...

methods passed to neuprint_login

See Also

neuprint_login, neuprint_datasets, neuprint_ROI_hierarchy


natverse/neuprintr documentation built on Sept. 15, 2023, 6:59 a.m.