create_plink_options: Create the options to run PLINK

In richelbilderbeek/plinkr: Interface to PLINK

Create the options to run PLINK

Description

Create the options to run PLINK. Options are:

Usage

create_plink_options(
  plink_version = get_default_plink_version(),
  plink_exe_path = get_default_plink_exe_path(),
  os = get_os()
)

Arguments

plink_version	version of PLINK, e.g. "1.7" Use get_plink_version to get the PLINK version. Use get_plink_versions to get all the supported PLINK versions.
plink_exe_path	path to the PLINK or PLINK2 executable file.
os	name of the operating system, as returned by app_dir

Details

• create_plink_v1_7_options: use PLINK v1.7

• create_plink_v1_9_options: use PLINK v1.9

• create_custom_plink_options: use a custom version of PLINK

Prefer to call these more specialized functions.

Value

the PLINK options, as can be checked by check_plink_options

Author(s)

Richèl J.C. Bilderbeek

Examples

# Use the default PLINK version
create_plink_options()

# Use PLINK v1.7
create_plink_v1_7_options()

# Use PLINK v1.9
create_plink_v1_9_options()

# Use PLINK v2.0
create_plink_v2_0_options()

# Use a custom PLINK version
create_custom_plink_options(
  plink_exe_path = "path_to_my_custom_plink_folder/plink3.mp4"
)

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