Difference between revisions of "Tutorials"

From Statistical Genetics Courses

Jump to: navigation, search
(→‎Tutorial specific instructions)
(→‎Running Tutorials on Your Computer)
Line 1: Line 1:
 
==Running Tutorials on Your Computer==
 
==Running Tutorials on Your Computer==
−
Starting Fall 2019 we 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.
+
Starting Fall 2019 we 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) or even a high performance computing cluster (if properly configured) for your own data analysis.
  
−
In this document we will focus on discussing how to set it up and run course tutorials on your computer, using these docker images and optionally a utility script we created to streamline various docker commands.
 
  
−
===Pre-requisites===
+
* [https://github.com/statgenetics/statgen-courses/wiki/How-to-launch-course-tutorials#alternative-to-cloud-server-use-your-own-computer Instructions to setup course tutorial environment on your computer]
−
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.
 
−
 
−
Finally please download our utility script [https://raw.githubusercontent.com/statgenetics/statgen-courses/master/src/statgen-setup <code>src/statgen-setup</code>] to your <code>PATH</code> and change it to executable, eg, <code>chmod +x ~/bin/statgen-setup</code> if you put it under <code>~/bin</code> which is part of your <code>PATH</code>. To verify your setup, type:
 
−
 
−
<pre>statgen-setup -h</pre>
 
−
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===
 
===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. 
+
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.
  
 
==Alohomora==
 
==Alohomora==

Revision as of 20:36, 1 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.

Alohomora

Annotation

To run the exercise from docker image provided, 

statgen-setup login --tutorial annovar

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

Annovar MEndelian

Cochran Armitage Trend Test


Epistasis (PLINK and CASSI)

To run the exercise from docker image provided, 

statgen-setup login --tutorial epistasis

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


FastLMM

To run the exercise from docker image provided, 

statgen-setup login --tutorial fastlmm-gcta

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

GCTA

To run the exercise from docker image provided, 

statgen-setup login --tutorial fastlmm-gcta

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

Gemini

To run the exercise from docker image provided, 

statgen-setup login --tutorial gemini

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


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

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


GWAS: Association Analysis Controlling for Population Substructure

To run the exercise from docker image provided, 

statgen-setup login --tutorial plink

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


Homozygosity Mapper

IGV

To run the exercise from docker image provided, 

statgen-setup login --tutorial igv

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

Linkage/FastLinkage


To run the exercise from docker image provided, 

statgen-setup login --tutorial mlink

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

Pleiotropy

To run the exercise from docker image provided, 

statgen-setup login --tutorial pleiotropy

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

Polygenic risk prediction (NPS method)

To run the exercise from docker image provided, 

statgen-setup login --tutorial nps

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

Population Genetics


To run the exercise from docker image provided, 

statgen-setup login --tutorial popgen

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

PSEQ

To run the exercise from docker image provided, 

statgen-setup login --tutorial pseq

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

Regression

To run the exercise from docker image provided, 

statgen-setup login --tutorial regression

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

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 login --tutorial vat

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

Retrieved from "http://statgen.us/index.php?title=Tutorials&oldid=1316"