make_bed: Convert to 'PLINK' binary files

View source: R/make_bed.R

make_bedR Documentation

Convert to PLINK binary files

Description

There are two ways to convert to binary files:

Usage

make_bed(
  base_input_filename,
  base_output_filename = file.path(dirname(base_input_filename), "output"),
  plink_options = create_plink_v1_9_options(),
  verbose = FALSE
)

Arguments

base_input_filename

the base of the filenames that are used as input for PLINK/PLINK2

base_output_filename

the base of the filenames that are used as output for PLINK/PLINK2

plink_options

options to run PLINK, as created by create_plink_options

verbose

the verbosity of a function. Set to TRUE for more output. Use check_verbose to detect if this argument is valid.

Details

  • Convert PLINK text files to PLINK binary files using PLINK, using make_bed_with_plink

  • Convert PLINK2 binary files to PLINK binary files using PLINK2 using make_bed_with_plink2

Value

The full names of the created PLINK1 binary files, which are a .bed, .bim, .fam and .log file.

Note

this function is named after the PLINK/PLINK2 --make-bed parameter flag

Author(s)

Richèl J.C. Bilderbeek


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