nv_collection: Neurovault Collections

Description Usage Arguments Value Note Examples

View source: R/nv_collections.R

Description

Returns a list of dictionaries with information corresponding to each collection stored in NeuroVault. Results can be filtered by specifying the name, DOI or owner of the collection.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
nv_collection(
  id = NULL,
  doi = NULL,
  owner = NULL,
  name = NULL,
  verbose = TRUE,
  secure = TRUE,
  max_count = Inf,
  ...
)

Arguments

id

id of the collection

doi

Digital Object Identifier (DOI) for the project or collection

owner

owner of the collection

name

name of the collection

verbose

print diagnostic messages

secure

passed to nv_base_url for https

max_count

Maximum count of records to call, the number of records may be larger than this based on how the limits are set for API calls

...

additional options to pass to GET

Value

List of the result of the GET call and the content

Note

See https://neurovault.org/api-docs

Examples

1
2
3
4
5
res = nv_collection(doi = "10.1016/j.neurobiolaging.2012.11.002")
res = nv_collection(name = "21 pain studies (NIDM-Results)")
res = nv_collection(id = 77)
res = nv_collection(id = 77, doi = "10.1016/j.neurobiolaging.2012.11.002")
res = nv_collection(max_count = 100)

muschellij2/neurovault documentation built on Dec. 16, 2019, 10:41 p.m.