nsrr_datasets: NSRR data sets

In neuroconductor-devel/nsrr: Interface to National Sleep Research Resource

NSRR data sets

Description

NSRR data sets

Usage

nsrr_datasets(token = nsrr_token(), page = NULL)

nsrr_dataset(dataset = NULL, token = nsrr_token())

nsrr_dataset_files(dataset = NULL, path = NULL, token = nsrr_token())

Arguments

token	Token for NSRR resources. Found at https://sleepdata.org/token
page	which page to grab. Increment over successive requests to retrieve all datasets. A request that return NULL or a number of datasets less than 18 indicates the last page.
dataset	a dataset "slug", one from nsrr_datasets
path	a folder or file path inside the dataset

Value

A data.frame of the data sets and their endpoints

Examples

df = nsrr_datasets(page = 1)
on_cran = !identical(Sys.getenv("NOT_CRAN"), "true")
on_ci <- nzchar(Sys.getenv("CI"))
local_run = grepl("musch", tolower(Sys.info()[["user"]]))
run_example = !on_cran || on_ci || local_run
if (run_example) {
  df = nsrr_datasets()
  if (attributes(df)$status_code == 200) {
    testthat::expect_is(df, "data.frame")
    slugs = c("abc", "bestair", "chat", "ccshs", "cfs",
              "heartbeat", "hchs", "homepap", "haassa", "learn")
    testthat::expect_true(all(slugs %in% df$slug))
  }
}
nsrr_dataset(dataset = "shhs", token = "")
dataset = "shhs"
token = NULL
df = nsrr_dataset_files(dataset)
ddf = nsrr_dataset_files(dataset, path = df$full_path[1])


dataset = "shhs"
token = NULL
df = nsrr_dataset_files(dataset)
nsrr_dataset_files(dataset = "wecare")

testthat::expect_error(nsrr_dataset_files(), "one data")
testthat::expect_error(nsrr_dataset_files(c("shhs", "chat")), "one data")

neuroconductor-devel/nsrr documentation built on Feb. 19, 2025, 6:10 a.m.