run_inspector: Runs the QC pipeline on a set of GWAS result files

View source: R/run_inspector.R

run_inspectorR Documentation

Runs the QC pipeline on a set of GWAS result files

Description

This is the main function of the package for running the QC algorithm on a set of GWAS result files. It requires an object of class Inspector which should be created by setup_inspector. Check the package vignette and tutorial for more details on this topic.

Usage

run_inspector(inspector, verbose = TRUE, test.run = FALSE)

Arguments

inspector

An instance of Inspector class. Check setup_inspector for more details.

verbose

logical. If FALSE, no messages will show up in the terminal and are only saved in the log file.

test.run

logical. If TRUE, only the first 1000 lines of each data file are loaded and analyzed; plots and saving the cleaned output dataset are skipped. Default value is FALSE.

Value

Reports from running the algorithm on a single or a series of GWAS result files are generated and saved.


GWASinspector documentation built on Sept. 28, 2023, 1:06 a.m.