getDataObject_GeneSymbol_SNP6: getDataObject_GeneSymbol_SNP6

Description Usage Arguments Value Examples

View source: R/getDataObject.R

Description

Returns an R object with the data for the requested vector, and annotations for samples, genome, and diseases.

Usage

1
2
3
4
getDataObject_GeneSymbol_SNP6(theGeneEqList,
theZipFile="/geneSurveyData/GeneSurvey.zip",
theRemoveDupFlag = TRUE, theVerboseFlag = FALSE, theRDataFile = NULL,
theListOnlyFlag=FALSE, theUseDeltaFlag=FALSE)

Arguments

theGeneEqList

A vector of gene symbol names as found in the getNames_ function for this data type.

theZipFile

Default: For DQS Servers. If you are on a server where the GENE_REPORT directory is on a different path, you can pass in a value to override the default of "/geneSurveyData/GeneSurvey.zip".

theRemoveDupFlag

Default: FALSE. Remove the duplicate barcodes from the same control samples used in different diseases.

theVerboseFlag

Default: FALSE. TRUE means write all output, which can be very verbose.

theRDataFile

Default: NULL. If non null, uses this value as a full path, including filename, to write a file with the given object.

theListOnlyFlag

Default: FALSE. If TRUE, save the RData file as a list with elements matching the object slots, so it can be shared with people who do not have the package.

theUseDeltaFlag

Default: FALSE. A flag indicating to use the differences in value between tumor and normal samples.

Value

The return value is an object. The following functions work to pull data out of the object.

get.Data

get.Data

get.GenomeAnnotations

get.GenomeAnnotations

get.SampleAnnotations

get.SampleAnnotations

get.TissueAnnotations

get.TissueAnnotations

Examples

1
#See examples in tests directory in the install.

MD-Anderson-Bioinformatics/GeneSurvey documentation built on May 7, 2019, 2:04 p.m.