getMetadata_GeneByNeighbor_HG18: getMetadata_GeneByNeighbor_HG18

Description Usage Arguments Value Examples

View source: R/getMetadata_HG.R

Description

Get the metadata about the gene(s) within a given range.

Usage

1
getMetadata_GeneByNeighbor_HG18(theStartPosition, theStopPosition, theChromosome, theStrand, theZipFile="/rsrch1/bcb/batcheffects/GENE_REPORT/GeneSurvey.zip", theVerboseFlag = FALSE)

Arguments

theStartPosition

Inclusive position to start search.

theStopPosition

Inclusive position to stop search.

theChromosome

Chromosome (as string) to search, such as "X", "Y", "1", or "21" - NULL skips.

theStrand

Strand as a string "+" or "-" - NULL skips

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 "/rsrch1/bcb/batcheffects/GENE_REPORT/GeneSurvey.zip". NOTE: this is a subdirectory of GENE_REPORT.

theVerboseFlag

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

Value

The return value is a list of objects with gene data. The following functions work to pull data out of the object.

get.GeneSymbol

get.GeneSymbol

get.GeneId

get.GeneId

get.VersionIndex

get.VersionIndex

get.LocationStart

get.LocationStart

get.LocationEnd

get.LocationEnd

get.Chromosome

get.Chromosome

get.Strand

get.Strand

Examples

1
2
3
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

GeneSurvey/TCGAGeneReport documentation built on May 6, 2019, 6:27 p.m.