Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 2.03 KB

README.md

File metadata and controls

82 lines (59 loc) · 2.03 KB

HAPPI GWAS

HAPPI GWAS is a genome-wide association study (GWAS) tool written in R.

Installation

You can install the HAPPI.GWAS from Github with:

# Run this inside R environment
install.packages("devtools", dependencies = TRUE)
devtools::install_github("Angelovici-Lab/HAPPI.GWAS")
# Run this in your terminal
mkdir HAPPI_GWAS
cd HAPPI_GWAS
git clone https://github.com/Angelovici-Lab/HAPPI.GWAS.git
cd HAPPI.GWAS
Rscript setup.R

Usage

Rscript HAPPI_GWAS.R [-h] [-generateBLUP] [-generateBLUE] [-GAPIT] [-extractHaplotype] [-searchGenes] input

positional arguments:
  input              Input YAML File

optional arguments:
  -h, --help         show this help message and exit
  -generateBLUP      Generate BLUP data from raw data
  -generateBLUE      Generate BLUE data from raw data
  -GAPIT             Run GAPIT
  -extractHaplotype  Extract haplotype (Require: -GAPIT)
  -searchGenes       Search genes (Require: -GAPIT)

Example

This is a basic example which shows you how to use HAPPI.GWAS:

cd /path/to/HAPPI_GWAS/HAPPI.GWAS
Rscript HAPPI_GWAS.R -GAPIT -extractHaplotype -searchGenes Demo_GLM.yaml
Rscript HAPPI_GWAS.R -GAPIT -extractHaplotype -searchGenes Demo_FarmCPU.yaml

Package Update

To upgrade HAPPI.GWAS to the latest version, please remove the package and re-install the latest HAPPI.GWAS package:

# Run this inside R environment
remove.packages("HAPPI.GWAS")
devtools::install_github("Angelovici-Lab/HAPPI.GWAS")
# Run this in your terminal
cd /path/to/HAPPI_GWAS/HAPPI.GWAS
git pull

Wiki

HAPPI GWAS Wiki Page

User Manual

HAPPI GWAS User Manual

Updates

10-02-2020: Updated the DESCRIPTION file because LDHeatmap was removed from CRAN
05-28-2020: Added HAPPI GWAS user manual
05-16-2020: Added HAPPI GWAS wiki page