get_plink_help_text: Get the text of the PLINK help file

View source: R/get_plink_help_text.R

get_plink_help_textR Documentation

Description

Get the text of the PLINK help file

Usage

get_plink_help_text(plink_options = create_plink_options())

Arguments

plink_options

options to run PLINK, as created by create_plink_options

Value

the text of the PLINK help file

Author(s)

Richèl J.C. Bilderbeek

Examples

if (is_plink_installed()) {

  # Default version
  get_plink_help_text()

  # PLINK v1.7
  get_plink_help_text(create_plink_v1_7_options())

  # PLINK v1.9
  get_plink_help_text(create_plink_v1_9_options())

  # Custom PLINK version, secretly v1.9
  plink_folder <- dirname(create_plink_v1_9_options()$plink_exe_path)
  get_plink_help_text(create_custom_plink_options(plink_folder))
}

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