matrix_info {geneExpression} R Documentation

get matrix summary information

Description

Usage

matrix_info(file);

Arguments

file

could be a file path or the HTS matrix data object

Details

the summary information of a csv/tsv/xls table file is not implemented at this moment, an NotImplementedException will be thrown for such kind of the input file.

Authors

phenotype_kit

Value

A tuple list object that contains the data information which is extract from the given file:

  1. sampleID: a character vector that contains the matrix sample information(column features name)
  2. geneID: a character vector that contains the matrix gene features information(row features name)
  3. tag: the matrix source tag label, could be the file basename if the given input file is a file path to the matrix.

if the input file object is a Matrix expression matrix object, then an additional mad data slot will be added into the result list: the MAD value of each gene feature row.

the list data also has some specificied data fields: list(sampleID, geneID, tag, mad).

clr value class

Examples

 str(matrix_info(file = "/path/to/expr_mat.csv"));
[Package geneExpression version 1.0.0.0 Index]