write_dbgap: Write dbGaP files

Description Usage Arguments Details Value

View source: R/write_functions.R

Description

Wrapper to write.table function to output dbGaP dataset (DS) and data dictionary (DD) files.

Usage

1
2
write_dbgap(x, file = "", study_name = NULL, phs = NULL,
  DD = FALSE, dstype = "", generate_fn = FALSE)

Arguments

x

Object to write out

file

Filename. Can leave unspecified if generate_fn=TRUE

study_name

Study name

phs

dbGaP PHS accession number

DD

logical flag, set to TRUE for DD file, FALSE for DS

dstype

Type of file, one of "pheno","ped","sattr","ssm","subj." Can be left as default/NULL if generate_fn=FALSE

generate_fn

logical flag on whether to have filename generated for you

Details

If generate_fn=FALSE, the argument to file will be used as the file name. File paths will be followed; if none given, will write to current working directory. If generate_fn=TRUE, one of either study_name or phs must be provided. If generate_fn=TRUE, fill will always be written to current working directory.

Value

Write file to disk.


UW-GAC/dbgaptools documentation built on Nov. 3, 2020, 12:19 a.m.