analysis_association: Run association analysis

Description Usage Arguments Details Value

View source: R/plink_calls.R

Description

Calls PLINK to run an association analysis on specified data.

Usage

1
2
3
4
5
6
7
8
analysis_association(
  geno_file,
  pheno_file,
  pheno_name,
  out_dir,
  bed = TRUE,
  plink_path = TRUE
)

Arguments

geno_file

string specifying path to genotypes file, including file extension.

pheno_file

string specifying path to phenotypes file, including file extension.

pheno_name

column name of phenotype to be used in analysis.

out_dir

directory to save results in, including "/" or "\\" at the end.

bed

logical indicating whether or not the genotypes file is a .bed file. FALSE if the file is .ped.

plink_path

TRUE if user has added PLINK to the system variable "PATH". Otherwise a string specifying the path to the folder containing plink.exe.

Details

PLINK uses the pheno_name column to determine which kind of analysis to run on the data.

Value

Does not return anything, but PLINK writes its results to disk in out_dir. The name of the written file depends on pheno_name:

The file format of the written file and the columns contained in it depends on which phenotype is used for the analysis.


FireGutter/geneference documentation built on Dec. 17, 2021, 8:27 p.m.