Difference between revisions of "Tutorials"

From Statistical Genetics Courses

Jump to: navigation, search
(Pleiotropy)
 
(213 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
==Tutorials for Courses==
 +
* [[Tutorials#FastLMM_&_GCTA|FastLMM & GCTA]] 
 +
* [[Tutorials#Mendelian Randomization|Mendelian Randomization]]
 +
* [[Tutorials#Pleiotropy|Pleiotropy]]
 +
* [[Tutorials#PLINK_GWAS:_Data_Quality_Control_and Association_Analysis_Controlling_for_Population_Substructure|PLINK GWAS: QC and Controlling for Population Substructure]]
 +
* [[Tutorials#Power_Analysis|Power Analysis]]
 +
* [[Tutorials#REGENIE|REGENIE]]
 +
* [[Tutorials#Regression_and_Intro_to_PLINK_and_R|Regression and Intro to PLINK and R]]
 +
* [[Tutorials#Pencil_and_Paper_Exercise|Pencil and Paper Exercise]]
 +
 
==Running Tutorials on Your Computer==
 
==Running Tutorials on Your Computer==
We have created a debian repository to make it easier to use our tutorials. Using this repository will require that you have administrator access to the computer on which you'll be using them. If you don't have this level of access, we also provide a pre-configured virtual machine image that will allow you to install software as root.
+
We adopt [https://www.docker.com/ docker] to run our course material, and we have created various [https://hub.docker.com/u/statisticalgenetics docker repositories] with freely available Docker images for users to readily run our exercises on their own computers using [https://docs.docker.com/desktop/ Docker Desktop]. These docker images are for multi-platform use (Mac, Windows, or Linux). More information regarding instructions to install Docker Desktop and to run the course material on your computer is detailed in the documentation below. 
 +
 
 +
===General instructions===
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Statistical_Genetics_Exercise_Instructions.pdf Instructions to install Docker Desktop and running the course material on your computer]
 +
 
 +
===Tutorial specific instructions===
 +
Please refer to the previous section for instructions on the installation of Docker Desktop and basic usages. 
 +
 
 +
Material and instructions for specific exercise are listed in each section below. They provide links to pdf versions of the exercises and a minimal set of commands to use for downloading the docker images and running an exercise. 
  
The VM Image is available [https://statgen.research.bcm.edu/files/images/Statgen.ova here]. The password for the student account is "LetMeIn". Feel free to change it to whatever you like.
+
==FastLMM & GCTA==
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/FastLMM_GCTA.pdf FastLMM & GCTA Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/FastLMM_GCTA_Outputs.pdf FastLMM & GCTA Output [PDF]]
 +
* [https://hub.docker.com/r/statisticalgenetics/fastlmm-gcta FastLMM & GCTA Docker Image]
  
If you would like to use our repository on a VM or on your computer, follow these configuration steps. Please run as the root user or using the sudo command.
+
To pull and download the docker image from the Docker Hub repository,
  
<pre>echo "deb [trusted=yes] https://statgen.research.bcm.edu/deb ./" | sudo tee -a /etc/apt/sources.list.d/statgen.list
+
<pre>docker pull statisticalgenetics/fastlmm-gcta</pre>
sudo add-apt-repository ppa:webupd8team/java
+
To run the exercise from the downloaded docker image,
sudo apt-get update
+
</pre>
+
  
==Annotation==
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/fastlmm-gcta</pre>
[http://statgen.us/files/tutorials/functional-annotation/FunctionalAnnotation_exercise_2018v2.pdf Functional Annotation Exercise <nowiki>[PDF]</nowiki>]
+
  
==GenABEL==
+
==Mendelian Randomization==
[http://statgen.us/files/tutorials/genabel/GenABEL_with_PLINK1.9.pdf GenABEL Exercise <nowiki>[PDF]</nowiki>]
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Mendelian_Randomization.pdf Mendelian Randomization Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Mendelian_Randomization_Outputs.pdf// Mendelian Randomization Output [PDF]]
 +
* [https://hub.docker.com/r/statisticalgenetics/mendelian-randomization Mendelian Randomization Docker Image]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Mendelian_Randomization_Questions.pdf Mendelian Randomization Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Mendelian_Randomization_Answers.pdf Mendelian Randomization Answers [PDF]]
  
==GWAS: Data Quality Control==
+
To pull and download the docker image from the Docker Hub repository,
* [http://statgen.us/files/tutorials/gwas-qc/PLINK_data_QC.pdf Exercise <nowiki>[PDF]</nowiki>]
+
  
====Installing Packages====
+
<pre>docker pull statisticalgenetics/mendelian-randomization</pre>
To install from packages, follow the configuration steps above and run the following command.
+
To run the exercise from the downloaded docker image,
  
<pre>sudo apt-get install plink-tutorial</pre>
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/mendelian-randomization</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.
+
  
 +
==Pleiotropy and Mediation Analysis==
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Pleiotropy.pdf Pleiotropy Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Pleiotropy_Outputs.pdf Pleiotropy Output [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Pleiotropy_answers.pdf Pleiotropy Docker Image]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Pleiotropy_Questions.pdf Pleiotropy Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Pleiotropy_Answers.pdf Pleiotropy Answers [PDF]]
  
 +
To pull and download the docker image from the Docker Hub repository,
  
==GWAS: Association Analysis Controlling for Population Substructure==
+
<pre>docker pull statisticalgenetics/pleiotropy</pre>
* [http://statgen.us/files/tutorials/gwas-substructure/GWAS_Data_Controlling_for_Substructure.pdf Exercise <nowiki>[PDF]</nowiki>]
+
To run the exercise from the downloaded docker image,
  
====Installing Packages====
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/pleiotropy</pre>
To install from packages, follow the configuration steps above and run the following command.
+
  
<pre>sudo apt-get install plink-tutorial</pre>
+
==PLINK GWAS: Data Quality Control and Association Analysis Controlling for Population Substructure==
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.
+
These exercises run using a shared docker image, however the exercises are split into two separate notebooks.
  
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_Data_QC.pdf PLINK GWAS: Data QC Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_Data_QC_Outputs.pdf PLINK GWAS: Data QC Output [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_Data_QC_Questions.pdf PLINK GWAS: Data QC Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_Data_QC_Answers.pdf PLINK GWAS: Data QC Answers [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_GWAS_Substructure.pdf PLINK GWAS: Population Substructure Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_GWAS_Substructure_Outputs.pdf PLINK GWAS: Population Substructure Output [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_GWAS_Substructure_Questions.pdf PLINK GWAS: Population Substructure Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/PLINK_GWAS_Substructure_Answers.pdf PLINK GWAS: Population Substructure Answers [PDF]]
 +
* [https://hub.docker.com/r/statisticalgenetics/plink-gwas PLINK GWAS Docker Image]
  
 +
To pull and download the docker image from the Docker Hub repository,
  
==RV-TDT==
+
<pre>docker pull statisticalgenetics/plink-gwas</pre>
* [http://statgen.us/files/tutorials/rvtdt/rvtdt_exercise.pdf Exercise <nowiki>[PDF]</nowiki>]
+
To run the exercise from the downloaded docker image,
  
====Installing Packages====
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/plink-gwas</pre>
To install from packages, follow the configuration steps above and run the following command.
+
  
<pre>sudo apt-get install rvtdt-tutorial</pre>
+
==Power Analysis==
The exercise's files will then be installed in the folder ''/home/shared/rvtdt''. You can run from there or copy the files into your user's home directory and proceed with the exercise.
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Power_Calculations_Questions.pdf Power Analysis Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Power_Calculations_Answers.pdf Power Analysis Answers [PDF]]
  
==PSEQ==
+
==REGENIE==
* [http://statgen.us/files/tutorials/pseq/PSEQ_exercise.pdf PSEQ Exercise <nowiki>[PDF]</nowiki>]
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regenie.pdf Regenie Exercise [PDF]]
* [http://statgen.us/files/tutorials/pseq/PSEQ_commands.txt Commands in Excercise]
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regenie_Outputs.pdf Regenie Output [PDF]]
 +
* [https://hub.docker.com/r/statisticalgenetics/regenie Regenie Docker Image]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regenie_Questions.pdf Regenie Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regenie_Answers.pdf Regenie Answers [PDF]]
  
==SEQSpark==
+
To pull and download the docker image from the Docker Hub repository,
* [http://statgen.us/files/tutorials/seqspark/SEQSpark_exercise_Final_v4.pdf SEQSpark Exercise <nowiki>[PDF]</nowiki>]
+
* [http://statgen.us/files/images/SEQSpark.ova Virtual Machine Image]
+
  
====Installing Packages====
+
<pre>docker pull statisticalgenetics/regenie</pre>
To install from packages, follow the configuration steps above and run the following command.
+
To run the exercise from the downloaded docker image,
  
<pre>sudo apt-get install seqspark-tutorial</pre>
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/regenie</pre>
The exercise's files will then be installed in the folder ''/home/shared/seqspark''. You can run from there or copy the files into your user's home directory and proceed with the exercise.In order for the
+
commands to work correctly, you don't need to reboot, but you should log out and log back in to make sure that the computer's environment is correctly configured.
+
  
==Variant Association Tools==
+
==Regression and Intro to PLINK and R==
* [http://statgen.us/files/tutorials/vat/VAT_exercise_2018%20with_graphs.pdf VAT Exercise <nowiki>[PDF]</nowiki>]
+
These exercises run using a shared docker image, however the exercises are split into two separate notebooks.
  
====Installing Packages====
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regression.pdf Regression Exercise [PDF]]
To install from packages, follow the configuration steps above and run the following command.
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regression_Outputs.pdf Regression Output [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regression_Questions.pdf Regression Questions [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Regression_Answers.pdf Regression Answers [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Intro_Plink_R.pdf Intro to PLINK & R Exercise [PDF]]
 +
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Intro_Plink_R_Outputs.pdf Intro to PLINK & R Output [PDF]]
 +
* [https://hub.docker.com/r/statisticalgenetics/regression-plink-r Regression and Intro to PLINK & R Docker Image]
  
<pre>sudo apt-get install vtools-tutorial</pre>
+
To pull and download the docker image from the Docker Hub repository,
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.
+
  
==Cochran Armitage Trend Test==
+
<pre>docker pull statisticalgenetics/regression-plink-r</pre>
* [http://statgen.us/files/tutorials/Armitage_sample_size_Berlin_1.pdf CATT Exercise <nowiki>[PDF]</nowiki>]
+
To run the exercise from the downloaded docker image,
  
==Population Genetics==
+
<pre>docker run --rm -p 8888:8888 statisticalgenetics/regression-plink-r</pre>
* [http://statgen.us/files/tutorials/population/Popgen_exe_ans.pdf Popgen Exercise <nowiki>[PDF]</nowiki>]
+
* [http://statgen.us/files/tutorials/population/popgen_drift.q Commands for popgen_drift]
+
* [http://statgen.us/files/tutorials/population/popgen_selection.q Commands for popgen_selection]
+
  
==GATK and IGV==
+
==Pencil and Paper Exercise==
* [http://statgen.us/files/tutorials/Variant_calling_exercices_GATK_IGV.pdf GATK/IGV Exercise <nowiki>[PDF]</nowiki>]
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Population_Genetics_Questions.pdf Population Genetics Questions [PDF]]
===Software Links===
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Population_Genetics_Answers.pdf Population Genetics Answers [PDF]]
:::* [https://www.broadinstitute.org/gatk/ GATK]
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Linkage_Disequilibrium_Questions.pdf Linkage Disequilibrium Questions [PDF]]
:::* [http://www.broadinstitute.org/igv/ IGV] ([http://statgen.us/files/software/igv.jar Download JAR file])
+
* [https://github.com/statgenetics/statgen-courses/blob/master/handouts_2026/Linkage_Disequilibrium_Answers.pdf Linkage Disequilibrium Answers [PDF]]
===Result Files===
+
:::* [http://statgen.us/files/2016/07/gatk_results.tar.gz GATK/IGV exercise]
+

Latest revision as of 10:43, 22 September 2026

Tutorials for Courses

Running Tutorials on Your Computer

We adopt docker to run our course material, and we have created various docker repositories with freely available Docker images for users to readily run our exercises on their own computers using Docker Desktop. These docker images are for multi-platform use (Mac, Windows, or Linux). More information regarding instructions to install Docker Desktop and to run the course material on your computer is detailed in the documentation below. 

General instructions

Tutorial specific instructions

Please refer to the previous section for instructions on the installation of Docker Desktop and basic usages. 

Material and instructions for specific exercise are listed in each section below. They provide links to pdf versions of the exercises and a minimal set of commands to use for downloading the docker images and running an exercise. 

FastLMM & GCTA

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/fastlmm-gcta

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/fastlmm-gcta

Mendelian Randomization

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/mendelian-randomization

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/mendelian-randomization

Pleiotropy and Mediation Analysis

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/pleiotropy

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/pleiotropy

PLINK GWAS: Data Quality Control and Association Analysis Controlling for Population Substructure

These exercises run using a shared docker image, however the exercises are split into two separate notebooks.

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/plink-gwas

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/plink-gwas

Power Analysis

REGENIE

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/regenie

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/regenie

Regression and Intro to PLINK and R

These exercises run using a shared docker image, however the exercises are split into two separate notebooks.

To pull and download the docker image from the Docker Hub repository,

docker pull statisticalgenetics/regression-plink-r

To run the exercise from the downloaded docker image,

docker run --rm -p 8888:8888 statisticalgenetics/regression-plink-r

Pencil and Paper Exercise