read_plink_files {plmmr} | R Documentation |
A function to read in PLINK files using bigsnpr
methods
Description
A function to read in PLINK files using bigsnpr
methods
Usage
read_plink_files(
data_dir,
data_prefix,
rds_dir,
outfile,
parallel,
overwrite,
quiet
)
Arguments
data_dir |
The path to the bed/bim/fam data files, without a trailing "/" (e.g., use |
data_prefix |
The prefix (as a character string) of the bed/fam data files (e.g., |
rds_dir |
The path to the directory in which you want to create the new '.rds' and '.bk' files. Defaults to |
outfile |
Optional: the name (character string) of the prefix of the logfile to be written. Defaults to 'process_plink', i.e. you will get 'process_plink.log' as the outfile. |
parallel |
Logical: should the computations within this function be run in parallel? Defaults to TRUE. See |
overwrite |
Logical: if existing |
quiet |
Logical: should messages be printed to the console? Defaults to TRUE |
Value
'.rds' and '.bk' files are created in data_dir
, and obj
(a bigSNP
object) is returned. See bigsnpr
documentation for more info on the bigSNP
class.