updated docs

MRCIEU · Jan 6, 2022 · fff71db · fff71db
1 parent da6be5b
commit fff71db
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/mkdocs/index.md b/mkdocs/index.md
@@ -4,4 +4,8 @@
 [![Build Status](https://github.com/MRCIEU/vargwas/actions/workflows/test.yml/badge.svg)](https://github.com/MRCIEU/vargwas/actions)
 <!-- badges: end -->
 
-Software to perform genome-wide association study of SNP effects on trait variance
+Software to perform genome-wide association study of SNP effects on trait variance
+
+## Citation
+
+Lyon M, Millard L, Davey Smith G, Gaunt T, Tilling K. Hypothesis-free detection of gene-interaction effects on biomarker concentration in UK Biobank using variance prioritisation. MedRxiv (2022). <https://doi.org/10.1101/2022.01.05.21268406>
diff --git a/mkdocs/usage.md b/mkdocs/usage.md
@@ -7,7 +7,7 @@ Requires UNIX environment. Use [Docker](install.md#Docker) for Windows.
 
 Program to perform GWAS of trait variability against variants in the BGEN format
 Usage:
-  varGWAS v1.2.1 [OPTION...]
+  varGWAS v1.2.3 [OPTION...]
 
   -v, --variable_file arg  Path to phenotype file
   -s, --sep arg            File separator
@@ -17,8 +17,9 @@ Usage:
   -p, --phenotype arg      Column name for phenotype
   -i, --id arg             Column name for genotype identifier
   -m, --maf arg            Filter out variants with a MAF below this threshold
+  -f, --flip               Flip alleles
   -h, --help               Print usage
-  -t, --threads arg        Number of threads
+  -t, --threads arg        Number of threads (default: 8)
 ```
 
 ## Phenotypes