Difference between revisions of "Tutorials"

From Statistical Genetics Courses

Jump to: navigation, search
Line 12: Line 12:
 
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.
 
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.
  
We use a script [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup "statgen-setup"] to start the docker based environments for these tutorials. Please refer to the previous section for instructions on the installation of this script.  
+
We use a script [https://github.com/statgenetics/statgen-courses/blob/master/src/statgen-setup "statgen-setup"] to start the docker based environments for these tutorials. Please refer to the previous section for instructions on the installation of this script.
  
 
==Alohomora==
 
==Alohomora==
Line 36: Line 36:
 
==Cochran Armitage Trend Test==
 
==Cochran Armitage Trend Test==
 
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Armitage_sample_size.pdf CATT Exercise <nowiki>[PDF]</nowiki>]
 
* [https://github.com/statgenetics/statgen-courses/blob/master/handout/Armitage_sample_size.pdf CATT Exercise <nowiki>[PDF]</nowiki>]
 
  
  
Line 46: Line 45:
 
<pre>statgen-setup login --tutorial epistasis
 
<pre>statgen-setup login --tutorial epistasis
 
</pre>
 
</pre>
 
  
  
Line 155: Line 153:
 
</pre>
 
</pre>
  
Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type  
+
Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type
  
 
<pre>get-data</pre>
 
<pre>get-data</pre>
Line 199: Line 197:
 
</pre>
 
</pre>
  
Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type  
+
Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type
  
 
<pre>get-data</pre>
 
<pre>get-data</pre>
Line 257: Line 255:
  
 
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].
 
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].
 +
  
  

Revision as of 02:43, 4 November 2021

Running Tutorials on Your Computer

Starting Fall 2019 we adopt docker to run our course material . We have created various docker repositories with source material freely available from 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) or even a high performance computing cluster (if properly configured) for your own data analysis.



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.

We use a script "statgen-setup" to start the docker based environments for these tutorials. Please refer to the previous section for instructions on the installation of this script.

Alohomora

Annotation

To run the exercise from docker image provided,

statgen-setup login --tutorial annovar


Annovar MEndelian

Cochran Armitage Trend Test


Epistasis (PLINK and CASSI)

To run the exercise from docker image provided,

statgen-setup login --tutorial epistasis


FastLMM

To run the exercise from docker image provided,

statgen-setup login --tutorial fastlmm-gcta


GCTA

To run the exercise from docker image provided,

statgen-setup login --tutorial fastlmm-gcta


Gemini

To run the exercise from docker image provided,

statgen-setup login --tutorial gemini


Genehunter


To install from packages, follow the configuration steps above and run the following command.

sudo apt-get install genehunter-tutorial

The exercise's files will then be installed in the folder /home/shared/genehunter. You can run from there or copy the files into your user's home directory and proceed with the exercise.

GWAS: Data Quality Control

To run the exercise from docker image provided,

statgen-setup login --tutorial plink


GWAS: Association Analysis Controlling for Population Substructure

To run the exercise from docker image provided,

statgen-setup login --tutorial plink


Homozygosity Mapper

IGV


Linkage/FastLinkage


To run the exercise from docker image provided,

statgen-setup login --tutorial mlink


Pleiotropy

To run the exercise from docker image provided,

statgen-setup login --tutorial pleiotropy


Polygenic risk prediction (NPS method)

To run the exercise from docker image provided,

statgen-setup login --tutorial nps


Polygenic risk prediction (LDpred2 method)


To run the exercise from docker image provided,

statgen-setup launch --tutorial ldpred2

Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type

get-data

to load the data-set to the JupyterLab workspace.


Population Genetics


To run the exercise from docker image provided,

statgen-setup login --tutorial popgen


PSEQ

To run the exercise from docker image provided,

statgen-setup login --tutorial pseq


REGENIE


To run the exercise from docker image provided,

statgen-setup launch --tutorial regenie

Then follow prompts on the terminal output to open up the JupyterLab server in your web browser. If it is the first time you start this server, please open a command terminal inside JupyterLab, and type

get-data

to load the data-set to the JupyterLab workspace.


Regression

To run the exercise from docker image provided,

statgen-setup login --tutorial regression


RV-TDT

Installing Packages

To install from packages, follow the configuration steps above and run the following command.

sudo apt-get install rvtdt-tutorial

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.

SEQLinkage


To install from packages, follow the configuration steps above and run the following command.

sudo apt-get install seqlinkage-tutorial

The exercise's files will then be installed in the folder /home/shared/seqlinkage. You can run from there or copy the files into your user's home directory and proceed with the exercise.

SEQSpark

Installing Packages

To install from packages, follow the configuration steps above and run the following command.

sudo apt-get install seqspark-tutorial

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.

SLINK

To run the exercise from docker image provided,

statgen-setup login --tutorial slink

The "statgen-setup" script is available here and can be installed following these instructions.


SUPERLINK

Variant Association Tools


To run the exercise from docker image provided,

statgen-setup launch --tutorial vat