load_data: Loads a single dataset to a Seurat object.

Description Usage Arguments Value Examples

View source: R/read.R

Description

If there are multiple datasets available you need to specify one by setting ds to a dataset id or dataset title. To get an overview of availabe dataset use the fucntion ds_info.

Usage

1
2
3
4
5
6
7
8
load_data(
  ds,
  data_dir = DATA_DIR,
  additional_readers = list(),
  experimental_readers = F,
  expression_file,
  as_format
)

Arguments

ds

A single dataset ID or dataset title.

data_dir

The directory containing sub-folders of the "dataset_xxxx" form. Defaults to the directory provided by the FASTGenomics platform.

additional_readers

List to specify your own readers for the specific dataset format. Still experimental, by default an empty list

experimental_readers

Boolean whether FASTGenomics in-house experimental readers should be used. By default set to False.

expression_file

The name of the expression file you want to load. Only needed when there are multiple expression files in a dataset.

as_format

Specifies which reader should be uses for this dataset. Overwrites the auto-detection of the format. Possible parameters are the file extensions of our supported data formats: "h5ad", "h5", "hdf5", "loom", "rds", "csv", "tsv".

Value

dataset loaded as a Seurat Object

Examples

1
2
load_data()                    # returns the Seurat object if only one dataset is available
load_data('Test loom data')    # returns the Seurat object from dataset specified by title

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