ds_info: Get information on all available datasets in this analysis.

In FASTGenomics/jupyter-fgread-r: FASTGenomics read module for R

Description

The optional argument available under data_dir. The function then looks for all directories matching the ".*/dataset_\d{4}$" pattern and constructs a data frame with all data sets.

Usage

ds_info(
  ds = NULL,
  pretty = NULL,
  output = NULL,
  data_dir = DATA_DIR,
  ignore_empty = TRUE
)

Arguments

ds	A single dataset ID or dataset title. If set, only this dataset will be displayed.
pretty	Boolean whether to display some nicely formatted output, by default True
output	Boolean whether to return a DataFrame or not, by default True
data_dir	The directory containing sub-folders of the "dataset_xxxx" form. Defaults to the directory provided by the FASTGenomics platform.
ignore_empty	Whether to ignore if no datasets are attached or not. Defaults to TRUE.

Value

A data frame containing all, or a single dataset (depends on ds and output)

Examples

dsets <- ds_info()
dsets <- ds_info('Test loom data')

FASTGenomics/jupyter-fgread-r documentation built on March 10, 2021, 9:26 p.m.