get_plink_example_filename: Get the path to a PLINK example file

In richelbilderbeek/plinkr: Interface to PLINK

Get the path to a PLINK example file

Description

Get the path to a PLINK example file

Usage

get_plink_example_filename(
  example_filename,
  plink_options = create_plink_options()
)

Arguments

example_filename	name of the example file
plink_options	options to run PLINK, as created by create_plink_options

Value

the path to a PLINK example file, if it exists. Will stop if the file does not exist

Author(s)

Richèl J.C. Bilderbeek

Examples

if (is_plink_installed()) {
  get_plink_example_filename("toy.map")
  get_plink_example_filename("toy.ped")
}

# v.17
plink_options <- create_plink_v1_7_options()
if (is_plink_installed(plink_options)) {
  get_plink_example_filename("test.map", plink_options)
  get_plink_example_filename("test.ped", plink_options)
}

# v1.9
plink_options <- create_plink_v1_9_options()
if (is_plink_installed(plink_options)) {
  get_plink_example_filename("toy.map", plink_options)
  get_plink_example_filename("toy.ped", plink_options)
}

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