-
Notifications
You must be signed in to change notification settings - Fork 1
/
index.Rmd
46 lines (32 loc) · 2.13 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
---
title: "Snakemake for Biostatistics Quick-Start Tutorial"
site: workflowr::wflow_site
output:
workflowr::wflow_html:
toc: false
editor_options:
chunk_output_type: console
---
## Introduction
This website contains a short introduction to Snakemake intended for a biostatistics/statistical genetics audience. This tutorial is intended to be a "quick start". We should be able to cover this material in about an hour. With the material in this tutorial, you will be able to write a basic Snakemake pipeline and execute it either locally or on a cluster.
Due to time constraints, there is lots of material that we won't cover in this guide. Once you are started, there are several excellent resources for learning more.
This website was created for a tutorial given at the University of Michigan, so some instructions specifically reference U of M computing resources.
### Resources
Snakemake resources:
- [Snakemake Documentation](https://snakemake.readthedocs.io/en/stable/)
- [Snakemake for Bioinformatics Software Carpentry Course](https://carpentries-incubator.github.io/snakemake-novice-bioinformatics/)
Other resources:
- [Getting Started with Python Wiki](https://www.python.org/about/gettingstarted/)
- [ARC-TS User Guide for GreatLakes](https://arc.umich.edu/greatlakes/user-guide/)
- [Introduction to Unix shell](https://swcarpentry.github.io/shell-novice/)
### Pre-Requisites
In this tutorial, I will assume that you are using a computer with either a Linux or Mac operating system. If your personal computer runs Windows, I recommend doing this tutorial on one of the clusters available to you (e.g. the Biostatistics department cluster, the CSG cluster, or Great Lakes). It is possible to run Snakemake on Windows, but I do not have very much experience with this.
## Tutorial
0. [Installation and Set-Up](install.html)
1. [Introduction](introduction.html)
2. [Using Snakemake to Execute Commands](basics.html)
3. [Wildcards, Placeholders, and expand()](wildcards.html)
4. [Multistep Workflows](multistep.html)
5. [Params and Config Files](config.html)
6. [Running on the Cluster](cluster.html)
7. [Using Conda with Snakemake](conda.html)