Changes

From Statistical Genetics Courses

Jump to: navigation, search

Tutorials

1,541 bytes added, 04:23, 25 February 2020
/* RV-TDT */
==Running Tutorials on Your Computer==
Since Starting Fall 2019 we adopted adopt [https://www.docker.com/ docker] to run our course material . We have created various [https://hub.docker.com/u/statisticalgenetics docker repositories] with source material freely available from [https://github.com/statgenetics/statgen-courses github] for users to readily setup and reproduce our tutorials on their own computers. These docker images can also be used as production tool to run relevant software on your computer (Mac, Linux or Windows) for your own data analysis.  In this section document we will discuss focus on discussing how to set it up and run course materials tutorials on your computer, using these docker images and optionally a utility script we created to streamline various docker commands.
===Pre-requisites===
 
Software you need to install on your computer are <code>SoS</code> (a workflow system to run our course utility script) and <code>docker</code>.
====Mac and Linux users====
 
<code>SoS</code> requires Python 3.6+ to run. It is recommended that you install [https://docs.conda.io/en/latest/miniconda.html Miniconda] to run Python 3 if you don't have it already. Once you have Python 3 installed, simply type <code>pip install sos</code> to install <code>SoS</code>, or, check out [https://vatlab.github.io/sos-docs/running.html here for alternative installation methods] if you have troubles with that command. To install <code>docker</code> from command line please follow our instructions [http://statgen.us/lab-wiki/orientation/jupyter-setup.html#install-docker here]. Alternatively Mac users can download docker app for Mac and install from a graphical interface.
you should see some meaningful output.
==== Windows users==== Running these tutorials in Windows is currently not supported. Although in principle these docker images will also work in Windows, this has not yet been tested out and we are unable to provide sure instructions to setting it up. The utility script "statgen-setup" that we provide will certainly need adjustments (though minor) to work with Windows.
===Tutorial specific instructions===
 Material and instructions for specific exercise are listed in each section below (''only those using statgen-setup command are relevant to our docker based tutorials''). They provide links to materials and a minimal set of commands to use for launching and running an exercise. For advanced options and other features provided by our utility script please read here our [https://github.com/statgenetics/statgen-courses/blob/master/README.md complete documentation to the utility script here].
==Alohomora==
==Annotation==
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/FunctionalAnnotation.2019.docx Functional Annotation Exercise <nowiki>[DOCX]</nowiki>]
* [[Commands in Annotation Exercise|Exercise Commands]]
==Cochran Armitage Trend Test==
* [httphttps://statgengithub.uscom/statgenetics/statgen-courses/blob/filesmaster/tutorialshandout/Armitage_sample_size_revisedArmitage_sample_size.pdf CATT Exercise <nowiki>[PDF]</nowiki>]
==GATK and IGV==
* [http://statgen.us/files/tutorials/Variant_calling_exercices_GATK_IGV.pdf GATK/IGV Exercise <nowiki>[PDF]</nowiki>]
====Software Links====
:* [https://www.broadinstitute.org/gatk/ GATK]
:* [http://www.broadinstitute.org/igv/ IGV] ([http://statgen.us/files/software/igv.jar Download JAR file])
==Epistasis (PLINK and CASSI)==Result Files* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Epistasis_PLINK_CASSI.pdf Epistasis exercise <nowiki>[PDF]</nowiki>] To run the exercise from docker image provided, <pre>statgen-setup login --tutorial epistasis</pre> The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].   ==FastLMM==:* [httphttps://github.com/statgenetics/statgen-courses/blob/master/handout/FASTLMM.uspdf FastLMM exercise <nowiki>[PDF]</filesnowiki>] To run the exercise from docker image provided, <pre>statgen-setup login --tutorial fastlmm-gcta</2016pre> The "statgen-setup" script is available [https:/07/gatk_resultsgithub.tarcom/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.gz GATKcom/IGV statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions]. ==GCTA==* [https://github.com/statgenetics/statgen-courses/blob/master/handout/GCTA.pdf GCTA exercise<nowiki>[PDF]</nowiki>] To run the exercise from docker image provided, <pre>statgen-setup login --tutorial fastlmm-gcta</pre> The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
==Gemini==
The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
==GenABEL==
* [http://statgen.us/files/tutorials/genabel/GenABEL_with_PLINK1.9.pdf GenABEL Exercise <nowiki>[PDF]</nowiki>]
* [[GeneABEL Exercise|Exercise Commands]]
To install from packages, follow the configuration steps above and run the following command.
 
<pre>sudo apt-get install genabel-tutorial</pre>
The exercise's files will then be installed in the folder ''/home/shared/genabel''. You can run from there or copy the files into your user's home directory and proceed with the exercise.
==Genehunter==
==GWAS: Data Quality Control==
* [httphttps://statgengithub.uscom/filesstatgenetics/tutorials/gwasstatgen-qccourses/blob/master/handout/PLINK_data_QC_V2PLINK_data_QC.pdf docx Exercise <nowiki>[PDF]</nowiki>]
* [[GWAS Data QC Exercise|Exercise Commands]]
====Installing Packages====To install run the exercise from packagesdocker image provided, follow the configuration steps above  <pre>statgen-setup login --tutorial plink</pre> The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and run the can be installed following command[https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions]. 
<pre>sudo apt-get install plink-tutorial</pre>
The exercise's files will then be installed in the folder ''/home/shared/Plink_DataQC''. You can run from there or copy the files into your user's home directory and proceed with the exercise.
==GWAS: Association Analysis Controlling for Population Substructure==
* [httphttps://statgengithub.uscom/filesstatgenetics/tutorials/gwasstatgen-substructurecourses/blob/master/handout/GWAS_Data_Controlling_for_Substructure_V2PLINK_Substructure.pdf docx Exercise <nowiki>[PDF]</nowiki>]
* [[GWAS_Controlling_for_Population_Substructure|Exercise Commands]]
====Installing Packages====To install run the exercise from packagesdocker image provided, follow the configuration steps above and run the following command.
<pre>sudo aptstatgen-setup login -get install plink-tutorialplink</pre>The exercise's files will then be installed in the folder ''/home/shared/Plink_substructure''. You can run from there or copy the files into your user's home directory and proceed with the exercise.
==Homozygosity Mapper==The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
 
 
==Homozygosity Mapper==
* [http://statgen.us/files/tutorials/Homozygosity_mapping_exercise_part_1.pdf Exercise Part I]
* [http://statgen.us/files/tutorials/Homozygosity_mapping_exercise_part_2.pdf Exercise Part II]
==IGV==
* [http://statgen.us/files/software/igv/igv-2.3.97.jar igv.jar Software Link]
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/IGV.docx IGV exercise <nowiki>[DOCX]</nowiki>]
* [http://statgen.us/files/igv_exercise.zip Exercise files (VCF and BAM)]
<pre>statgen-setup login --tutorial mlink
</pre>
 
The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
 
==Pleiotropy==
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Pleiotropy.docx Pleiotropy Exercise <nowiki>[DOCX]</nowiki>]
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Pleiotropy_answers.docx Pleiotropy Answers to Questions <nowiki>[DOCX]</nowiki>]
 
To run the exercise from docker image provided,
 
<pre>statgen-setup login --tutorial pleiotropy
</pre>
 
The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
 
==Polygenic risk prediction (NPS method)==
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/NPS.docx PRS NPS Exercise <nowiki>[DOCX]</nowiki>]
 
To run the exercise from docker image provided,
 
<pre>statgen-setup login --tutorial nps
</pre>
==RV-TDT==
* [httphttps://statgengithub.uscom/statgenetics/statgen-courses/filesblob/tutorialsmaster/rvtdthandout/rvtdt_exercise_v3RV-TDT.pdf doc Exercise <nowiki>[PDFDOC]</nowiki>]
* [[RV-TDT|Exercise Commands]]
The "statgen-setup" script is available [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup here] and can be installed following [https://github.com/statgenetics/statgen-courses/blob/master/README.md#prepare-your-computer-to-manage-the-tutorials these instructions].
 
==VAT Mendelian==
* [http://statgen.us/files/tutorials/VAT_Mendelian.pdf Exercise <nowiki>[PDF]</nowiki>]
* [[VAT mendelian commands|Exercise Commands]]
 
 
To install from packages, follow the configuration steps above and run the following command.
 
<pre>sudo apt-get install vtools-mendelian-tutorial</pre>
The exercise's files will then be installed in the folder ''/home/shared/vat''. You can run from there or copy the files into your user's home directory and proceed with the exercise.