plinkr: Interface to PLINK

View source: R/read_plink_bed_file_from_files.R

read_plink_bed_file_from_files

R Documentation

Read a `PLINK`/`PLINK2` `.bed` file using a `.bim` and `.fam` file.

Description

Read a PLINK/PLINK2 .bed file using a .bim and .fam file. These two accessory files are used to extract the names of the individuals and the names of the loci. Use read_plink_bed_file to read a .bed file without those two accessory files.

Usage

read_plink_bed_file_from_files(
  bed_filename,
  bim_filename,
  fam_filename,
  verbose = FALSE
)

Arguments

`bed_filename`	name of a `PLINK` `.bed` file Use read_plink_bed_file to read a `PLINK` `.bed` file.
`bim_filename`	name of a `PLINK` `.bim` file Use read_plink_bim_file to read a `PLINK` `.bim` file.
`fam_filename`	name of a `PLINK` `.fam` file Use read_plink_fam_file to read a `PLINK` `.fam` file.
`verbose`	the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Author(s)

Richèl J.C. Bilderbeek

Examples

read_plink_bed_file_from_files(
  bed_filename = get_plinkr_filename("demo_assoc.bed"),
  bim_filename = get_plinkr_filename("demo_assoc.bim"),
  fam_filename = get_plinkr_filename("demo_assoc.fam")
)

richelbilderbeek/plinkr documentation built on March 25, 2024, 3:18 p.m.