read_tome_sample_data: Read Sample Expression Data from a tome file

Description Usage Arguments Value

View source: R/read_tome.R

Description

Read Sample Expression Data from a tome file

Usage

1
2
read_tome_sample_data(tome, samples, regions = "exon",
  units = "counts", transform = "none", format = "data.frame")

Arguments

tome

tome file to read. Required.

samples

A vector of sample names to read. Required

regions

The gene regions to use. Can be "exon", "intron", or "both". Default = "exon".

units

The type of values to return. Can be "counts" or "cpm". Default = "counts".

transform

Transformation to apply to values. Can be "none", "log", "log2", "log10". Log transforms will add 1 to values before transformation. Default = "none".

format

The format of the output. Can be "data.frame", "matrix", or "dgcMatrix" (sparse matrix). Default is "data.frame".

Value

A data.frame with gene_name as the first column and each subsequent column containing gene expression values and named for the samples; Or a matrix with columns as samples and rows as genes.


AllenInstitute/scrattch.io documentation built on Nov. 17, 2021, 10:06 a.m.