Skip to content

Commit 3a8217f

Browse files
committed
update titles
1 parent 77c2d29 commit 3a8217f

File tree

7 files changed

+359
-6
lines changed

7 files changed

+359
-6
lines changed

pages/resources/resources.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ <h2 class="page-header">Viruses</h2>
2323
</span>
2424
</div>
2525
<div class="media-body">
26-
<h4 class="media-heading"><a class="post-link" href="{{ page.url | remove: "/" }}">{{ page.title }}</a></h4>
26+
<h4 class="media-heading"><a class="post-link" href="{{ page.url | remove: "/" }}">{{ page.tname }}</a></h4>
2727
<p>{{ page.summary | strip_html | strip_newlines | truncate: 160 }}</p>
2828
</div>
2929
</div>
@@ -80,3 +80,5 @@ <h4 class="media-heading"><a class="post-link" href="{{ page.url | remove: "/" }
8080
{% endfor %}
8181
</div>
8282

83+
84+
{% include links.html %}

pages/resources/viruses/ebov.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: EBOV<br>(Ebola virus)
2+
tname: EBOV<br>(Ebola virus)
3+
title: EBOV (Ebola virus)
34
keywords: resources
45
summary: A collection of resources for whole genome sequencing and analysis of Ebola virus (EBOV)
56
image: images/ebov.png

pages/resources/viruses/mev.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: MeV<br>(Measles virus)
2+
title: MeV (Measles virus)
3+
tname: MeV<br>(Measles virus)
34
keywords: resources
45
summary: A collection of resources for whole genome sequencing and analysis of Measles virus (MeV)
56
image: images/mev.png
@@ -9,7 +10,7 @@ folder: viruses
910
tags: [resources, viruses]
1011
---
1112

12-
> A collection of resources for whole genome sequencing and analysis of Ebola virus (EBOV)
13+
> A collection of resources for whole genome sequencing and analysis of Measles virus (EBOV)
1314
1415
## Resources and documents
1516

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
---
2+
title: "Ebola virus Nanopore sequencing bioinformatics protocol | amplicon, native barcoding"
3+
keywords: protocol
4+
layout: document
5+
last_updated: Dec 12, 2019
6+
tags: [protocol]
7+
summary:
8+
permalink: ebov-bioinformatics-sop
9+
folder: ebov
10+
title_text: "Ebola virus bioinformatics protocol"
11+
subtitle_text: "Nanopore | bioinformatics"
12+
document_name: "ARTIC-EBOV-bioinformaticsSOP"
13+
version: v1.0.1
14+
creation_date: 2018-05-26
15+
revision_date:
16+
forked_from:
17+
author: Nick Loman
18+
citation: "Loman *et al.* In Prep."
19+
nav_menu: false
20+
show_tile: false
21+
category: ebov
22+
---
23+
24+
{% include callout.html
25+
type='default'
26+
content='**Overview:** A complete bioinformatics protocol to take the output from the [sequencing protocol](/ebov/ebov-seq-sop.html) to consensus genome sequences. Includes basecalling, de-multiplexing, mapping, polishing and consensus generation.
27+
'
28+
%}
29+
30+
<br />
31+
32+
This document is part of the Ebola virus Nanopore sequencing protocol package:
33+
: [http://artic.network/ebov/](http://artic.network/ebov/)
34+
35+
#### Related documents:
36+
37+
Ebola virus Nanopore sequencing protocol:
38+
: [http://artic.network/ebov/ebov-seq-sop.html](/ebov/ebov-seq-sop.html)
39+
40+
Setting up the laptop computing environment using Conda:
41+
: [http://artic.network/ebov/ebov-it-setup.html](http://artic.network/ebov/ebov-it-setup.html)
42+
43+
Phylogenetic analysis and visualization:
44+
: [http://artic.network/ebov/ebov-phylogenetics-sop.html](http://artic.network/ebov/ebov-phylogenetics-sop.html)
45+
46+
47+
<br /><br /><br />
48+
49+
{% include wellcome-trust.html %}
50+
51+
<div class="pagebreak"> </div>
52+
53+
## Preparation
54+
55+
Set up the computing environment as described here in this document: [ebov-it-setup](ebov-it-setup.html). This should be done and tested prior to sequencing, particularly if this will be done in an environment without internet access or where this is slow or unreliable. Once this is done, the bioinformatics can be performed largely off-line. If you are already using lab-on-SSD, you can skip this step.
56+
57+
## Make a new directory for analysis
58+
59+
Give your analysis directory a meaningful name, e.g.. analysis/run_name
60+
61+
```bash
62+
mkdir analysis
63+
cd analysis
64+
65+
mkdir run_name
66+
cd run_name
67+
```
68+
69+
## Activate the ARTIC environment:
70+
71+
All steps in this tutorial should be performed in the artic-ebov conda environment:
72+
73+
```bash
74+
source activate artic-ebov
75+
```
76+
77+
## RAMPART
78+
79+
To run RAMPART on a current run:
80+
81+
```bash
82+
artic rampart
83+
```
84+
85+
Select your run and protocol, enter the names of your barcodes, then open http://localhost:3000 in your browser.
86+
87+
### Basecalling with Guppy
88+
89+
If you did basecalling with MinKNOW, skip this step.
90+
91+
Run the Guppy basecaller on the new MinION run folder:
92+
93+
For fast mode basecalling:
94+
95+
```bash
96+
guppy_basecaller -c dna_r9.4.1_450bps_fast.cfg -i /path/to/reads -s run_name -x auto -r
97+
```
98+
99+
For high-accuracy mode basecalling:
100+
101+
```bash
102+
guppy_basecaller -c dna_r9.4.1_450bps_hac.cfg -i /path/to/reads -s run_name -x auto -r
103+
```
104+
105+
You need to substitute `/path/to/reads` to the folder where the FAST5 files from your
106+
run are. Common locations are:
107+
108+
- Mac: ```/Library/MinKNOW/data/run_name```
109+
- Linux: ```/var/lib/MinKNOW/data/run_name```
110+
- Windows ```c:/data/reads```
111+
112+
This will create a folder called `run_name` with the base-called reads in it.
113+
114+
### Consensus sequence generation
115+
116+
We first collect all the FASTQ files (typically stored in files each containing 4000 reads)
117+
into a single file.
118+
119+
```bash
120+
artic gather --min-length 400 --max-length 700 --prefix run_name
121+
```
122+
123+
The command will show you the runs in /var/lib/MinKNOW/data and ask you to select one. If you know the path to the reads use:
124+
125+
```bash
126+
artic gather --min-length 400 --max-length 700 --prefix run_name --directory /path/to/reads
127+
```
128+
129+
Here `/path_to_reads` should be the folder in which MinKNOW put the base-called reads (i.e., `run_name` from the command above).
130+
131+
We use a length filter here of between 400 and 700 to remove obviously chimeric reads.
132+
133+
You may need to change these numbers if you are using different length primer schemes. Try the minimum lengths of the amplicons as the
134+
minimum, and the maximum length of the amplicons plus 200 as the maximum.
135+
136+
I.e. if your amplicons are 300 base pairs, use --min-length 300 --max-length 500
137+
138+
You will now have a file called: ``run_name_pass.fastq``
139+
and a file called ``run_name_sequencing_summary.txt``,
140+
as well as individual files for each barcode (if previously demultiplexed).
141+
142+
### Demultiplex with Porechop with stringent settings
143+
144+
This stage is obligatory, even if you have already demultiplexed with Guppy, due to
145+
significant barcoding misassignments that can confound results:
146+
147+
```bash
148+
artic demultiplex --threads 4 run_name_pass.fastq
149+
```
150+
151+
Now you will have new files called:
152+
153+
```bash
154+
run_name_pass_NB01.fastq
155+
run_name_pass_NB02.fastq
156+
run_name_pass_NB03.fastq
157+
```
158+
159+
### Create the nanopolish index (once per sequencing run, not per sample)
160+
161+
```bash
162+
nanopolish index -s run_name_sequencing_summary.txt -d /path/to/reads run_name_pass.fastq
163+
```
164+
165+
Again, alter ``/path/to/reads`` to point to the original location of the FAST5 files.
166+
167+
## Run the MinION pipeline
168+
169+
For each barcode you wish to process (e.g. run this command 12 times for 12 barcodes), replacing the file name and sample name as appropriate:
170+
171+
E.g. for NB01
172+
173+
```bash
174+
artic minion --normalise 200 --threads 4 --scheme-directory ~/artic/artic-ebov/primer-schemes --read-file run_name_pass_NB01.fastq --nanopolish-read-file run_name_pass.fastq IturoEbola/V1 samplename
175+
```
176+
177+
Replace ``samplename`` as appropriate.
178+
179+
E.g. for NB02
180+
181+
```bash
182+
artic minion --normalise 200 --threads 4 --scheme-directory ~/artic/artic-ebov/primer-schemes --read-file run_name_pass_NB02.fastq --nanopolish-read-file run_name_pass.fastq IturoEbola/V1 samplename
183+
```
184+
185+
## Output files
186+
187+
* ``samplename.primertrimmed.bam`` - BAM file for visualisation after primer-binding site trimming
188+
* ``samplename.vcf`` - detected variants in VCF format
189+
* ``samplename.variants.tab`` - detected variants
190+
* ``samplename.consensus.fasta`` - consensus sequence
191+
192+
To put all the consensus sequences in one filei called my_consensus_genome, run
193+
194+
```bash
195+
cat *.consensus.fasta > my_consensus_genomes.fasta
196+
```
197+
198+
## To visualise genomes in Tablet
199+
200+
Open a new Terminal window:
201+
202+
```bash
203+
conda activate tablet
204+
tablet
205+
```
206+
207+
Go to "Open Assembly"
208+
209+
Load the BAM (binary alignment file) as the first file.
210+
211+
Load the refernece file (in artic/artic-ebov/primer_schemes/IturiEbola/V1/IturiEbola.reference.fasta) as the second file.
212+
213+
Select Variants mode in Color Schemes for ease of viewing variants.
214+
Lines changed: 133 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
---
2+
title: "Ebola virus Nanopore sequencing protocol | amplicon, native barcoding"
3+
keywords: protocol
4+
layout: document
5+
last_updated: May 18, 2018
6+
tags: [protocol]
7+
permalink: ebov-it-setup.html
8+
folder: ebov
9+
title_text: "Ebola virus bioinformatics environment setup"
10+
subtitle_text: "Nanopore | bioinformatics"
11+
document_name: "ARTIC-EBOV-ITSetup"
12+
version: v1.0.0
13+
creation_date: 2018-05-26
14+
forked_from:
15+
author: Nick Loman, Andrew Rambaut
16+
citation: "Loman *et al.* In Prep."
17+
nav_menu: false
18+
show_tile: false
19+
category: ebov
20+
---
21+
22+
{% include callout.html
23+
type='default'
24+
content='**Overview:** Instructions for setting up the laptop computing environment for running the MinION sequencer and performing the bioinformatics and downstream phylogenetic analyses.'
25+
%}
26+
27+
<br />
28+
29+
This document is part of the Ebola virus Nanopore sequencing protocol package:
30+
: [http://artic.network/ebov/](http://artic.network/ebov/)
31+
32+
#### Related documents:
33+
34+
Ebola virus Nanopore bioinformatics protocol:
35+
: [http://artic.network/ebov/ebov-bioinformatics-sop.html](http://artic.network/ebov/ebov-bioinformatics-sop.html)
36+
37+
Phylogenetic analysis and visualization:
38+
: [http://artic.network/ebov/ebov-phylogenetics-sop.html](http://artic.network/ebov/ebov-phylogenetics-sop.html)
39+
40+
41+
<br /><br /><br />
42+
43+
{% include wellcome-trust.html %}
44+
45+
<div class="pagebreak"> </div>
46+
47+
## Preparation
48+
49+
#### Equipment required:
50+
51+
Laptop requirements for MinION:
52+
: Intel i7 or Xeon processor
53+
: 16GB RAM
54+
: 1TB SSD hard drive
55+
: USB 3
56+
: Full Oxford Nanopore Technologies [lab and computing requirements are here](https://nanoporetech.com/sites/default/files/s3/MinION-Computer-Requirements-March-17_Final.pdf).
57+
58+
## Software Setup
59+
60+
These protocols instructions assume a 64-bit UNIX, Linux or similar environment. This could be Mac OS X (Yosemite or later), Linux (e.g., Ubuntu 16 or later), or Windows 10 Subsystem for Linux. It assumes familiarity with a UNIX-like *bash* command-line.
61+
62+
The steps in this document should be done and tested prior to sequencing, particularly if this will be done in an environment without internet access or where this is slow or unreliable. Once this is done, the bioinformatics and phylogenetics protocols can be performed largely off-line.
63+
64+
### Conda
65+
66+
Software will be installed using [Conda](https://conda.io/) -- a cross-platform package and dependency installer.
67+
68+
For Conda installation instructions for your operating system go to: [https://conda.io/docs/user-guide/install/](https://conda.io/docs/user-guide/install/). We suggest installing the `Miniconda` version which is relatively small and quick to install.
69+
70+
> *NOTE:* Install the `64-bit Python 3.6` version of Miniconda
71+
72+
### Installing ARTIC Ebola virus specific data and software
73+
74+
Install the ARTIC Ebola virus data and software repository:
75+
76+
```bash
77+
git clone --recursive https://github.com/artic-network/artic-ebov.git
78+
```
79+
80+
Create a custom Conda environment for running software. This may take some time as it will install the required packages and all their dependencies.
81+
82+
```bash
83+
conda env create -f artic-ebov/environment.yml
84+
```
85+
86+
```bash
87+
cd artic-ebov/fieldbioinformatics
88+
python setup.py install
89+
cd ../..
90+
```
91+
92+
93+
<!-- No longer necessary given environment yml file.
94+
First use the following commands to set up access to [BioConda](https://bioconda.github.io) (a repository of over 3000 bioinformatics packages):
95+
96+
```bash
97+
conda config --add channels conda-forge
98+
conda config --add channels bioconda
99+
```
100+
101+
Create an custom environment for running software and install the packages:
102+
103+
```bash
104+
conda create -n artic-ebov
105+
```
106+
-->
107+
108+
Although not strictly necessary this will prevent any conflicts with other similar software installed and can be readily removed. You can use this command to activate the environment:
109+
110+
```
111+
source activate artic-ebov
112+
```
113+
114+
and then deactivate it again using this:
115+
116+
```bash
117+
source deactivate
118+
```
119+
120+
The artic environment can be removed using this:
121+
122+
```bash
123+
conda remove --name artic-ebov --all
124+
```
125+
126+
### Installing Oxford Nanopore MinKNOW and Albacore
127+
128+
The software for running the MinION and basecalling can be downloaded from the [Oxford Nanopore Technologies Community site](https://community.nanoporetech.com). Log in to find the `Software Downloads` button. Download `MinKNOW 2.0` (currently v18.03.1) and `Albacore` (currently v2.3.1) appropriate to the system being used. Follow the `Installation guide` for each package.
129+
130+
MinKNOW is a graphical user-interface programme that will be installed in the application area of the system.
131+
132+
Python 3 is needed to both install and run Albacore but is installed by Conda if not already on your machine. Access to Albacore is through an excutable Python script called `read_fast5_basecaller.py` that will be installed in a directory on the path such as `/usr/local/bin/`.
133+

pages/resources/viruses/mpxv.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: MPXV <br>(mpox virus)
2+
tname: MPXV<br>(mpox virus)
3+
title: MPXV (mpox virus)
34
keywords: resources
45
summary: A collection of resources for whole genome sequencing and analysis of MPXV
56
image: /images/mpxv.png

0 commit comments

Comments
 (0)