searchCopyPhenoFiles: Copy phenotype files to project directory

Description Usage Arguments Value Methods (by class) Examples

Description

The method searches for the decrypted dbGaP phenotype files in a given directory and copies (or moves) the files to the configured project directory. When a study accession is provided, only the files of specified study are copied.

Usage

1
2
3
4
5
searchCopyPhenoFiles(object, userDataDir, ...)

## S4 method for signature 'Commons,character'
searchCopyPhenoFiles(object, userDataDir, ...,
  phsAcc = "", copyOrMove = "copy", showErr = TRUE)

Arguments

object

Commons class object.

userDataDir

a character string. The path to the top level directory of decrypted dbGaP phenotype files. The files can be from different studies and located in different sub-directories.

...

There are optional arguments.

phsAcc

a character string. The dbGaP study accession.

copyOrMove

a character string. (optional) If the string value is 'copy' (default), copies the files to the project directory. If the string value is 'move', movies the files from the user data directory to the project directory.

showErr

a logical value. (optional) If TRUE, display the error message; If FALSE (default), not display.

Value

(invisible) data frame. The meta-info of all copied files.

Methods (by class)

Examples

1
2
3
4
5
6
7
8
## Not run: 

c <- Commons()
searchCopyPhenoFiles(c, userDataDir = '/home/user/data')
# or
searchCopyPhenoFiles(c, userDataDir = '/home/user/data', phsAcc="phs000001.v3.p1")

## End(Not run)

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