import-method: Import LoomExperiment from LoomFile

import-methodsR Documentation

Import LoomExperiment from LoomFile

Description

Imports a LoomExperiment from a LoomFile. Note the colGraph and rowGraph contained within the 0-indexed loom file will be converted to the 1-indexed represnetation in the resulting LoomExperiment object.

Usage

## S4 method for signature 'LoomFile,ANY,ANY'
import(con, ...,
    type = c("SingleCellLoomExperiment", "LoomExperiment", "RangedLoomExperiment"),
    rownames_attr=NULL, colnames_attr=NULL)

Arguments

con

A character indicating the loom file to be created. File must have the .loom extension.

...

Additional arguments

type

Either "SingleCellLoomExperiment", "LoomExperiment", or "RangedLoomExperiment". This value decides what type of object that will be returned by import. If left empty import will either determine what type of class should be used by the context of the file. If it cannot be determined, the LoomExperiment type will default to SingleCellLoomExperiment.

rownames_attr

A character vector indicating the name of the rowData attribute to represent the names rownames in the LoomExperiment object.

colnames_attr

A character vector indicating the name of the colData attribute to represent the names colnames in the LoomExperiment object.

Value

An object of class LoomExperiment

See Also

LoomExperiment, LoomFile,

Examples

l1_file <- system.file("extdata", "L1_DRG_20_example.loom", package = "LoomExperiment")
scle <- import(l1_file, type="SingleCellLoomExperiment")
scle

Bioconductor/LoomExperiment documentation built on Nov. 2, 2024, 9:57 p.m.