save_fam_table: Save a '.fam' table to file.

In richelbilderbeek/plinkr: Interface to PLINK

Save a .fam table to file.

Description

Save a .fam table to file

Usage

save_fam_table(fam_table, fam_filename, verbose = FALSE)

Arguments

fam_table	a tibble of the genetic mapping, with as many rows as SNPs. Each row contains: fam: the family ID id: the individual's ID pat: ID of father mat: ID of mother sex: the gender pheno: a phenotype Use get_test_fam_table to get a .fam table as used in testing. Use read_plink_fam_file to read a PLINK .fam file. Use check_fam_table to test if a .fam table is valid.
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

fam_table <- get_test_fam_table()
fam_filename <- get_plinkr_tempfilename(fileext = ".fam")
save_fam_table(
  fam_table = fam_table,
  fam_filename = fam_filename
)
file.remove(fam_filename)

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