get_test_ped_table: Get a simple pedigree ('.ped') table.

View source: R/get_test_ped_table.R

get_test_ped_tableR Documentation

Get a simple pedigree (.ped) table.

Description

Get a simple pedigree (.ped) table, as can be used in testing. This is the same table as can be obtained by reading the PLINK v1.7 example file called test.ped.

Usage

get_test_ped_table()

Value

a pedigree (.ped) table

Note

The function has the word get in its name, as getting the result is trivial. When getting the result is non-trivial, the word create is used.

Author(s)

Richèl J.C. Bilderbeek

See Also

use create_demo_ped_table to get simulated pedigree tables

Examples

get_test_ped_table()

# Get the pedigree from the original PLINK v1.7 example file
if (is_plink_installed(create_plink_v1_7_options())) {
  ped_filename <- get_plink_example_filename(
    example_filename = "test.ped",
    create_plink_v1_7_options()
  )
  read_plink_ped_file(ped_filename)
}

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