keep: Filter 'PLINK' and 'PLINK2' data on their family ID

In richelbilderbeek/plinkr: Interface to PLINK

Filter PLINK and PLINK2 data on their family ID

Description

Filter PLINK and PLINK2 data on their family ID

Usage

keep(
  base_input_filename,
  sample_ids_filename,
  base_output_filename,
  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
sample_ids_filename	name of a file to store sample_ids (see check_sample_ids) to
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.

Value

the names of the files created

Note

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

Author(s)

Richèl J.C. Bilderbeek

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