filterBySubjIds: (internal) Filter dataset data by subject ids

In jameslhao/dbgapr_dev: A dbGaP Phenotype Data Organizer

Description

The method filters out the rows of a dataset by a given list of subject ids. The subject ids can be provided as a list or as a text file.

Usage

filterBySubjIds(object, varDF, ...)

## S4 method for signature 'Commons,data.frame'
filterBySubjIds(object, varDF, ...,
  dbgapIdsOrFile = NULL)

Arguments

object	Commons class object.
varDF	a data frame. The dataset data.
...	There are optional arguments.
dbgapIdsOrFile	a character vector or a character string. (optional) This argument can be either a vector of ID list or a path to a file that contains a list of IDs. The IDs can be dbGaP_Subject_ID or dbGaP_Sample_ID denpending on type of the data. When the list of IDs is provided by a file, it should be a plain text file with one ID per line.

Value

a data frame. Filtered dataset data.

Methods (by class)

• object = Commons,varDF = data.frame: A method of class Commons

Examples

## Not run: 

c <- Commons()
filterBySubjIds(c, varDF = varDF, dbgapIdsOrFile = c("219", "220", "223"))

## End(Not run)

jameslhao/dbgapr_dev documentation built on May 8, 2019, 11:03 p.m.