millironx/sc2-sequencing
1
0
Fork 0
mirror of https://github.com/MillironX/sc2-sequencing.git synced 2024-12-22 03:08:17 +00:00
Code Issues Releases Packages Activity

Cleanup ONT README

Browse source
This commit is contained in:
Thomas A. Christensen II 2021-04-13 13:56:10 -06:00
parent ab3f468564
commit f4c8b4da97
Signed by: millironx
GPG key ID: 139C07724802BC5D
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
ont/README.md
View file

@ -1,9 +1,12 @@
# Oxford Nanopore Technologies
These scripts are for use with a GridION, to make the files and folder structures correspond more closely to those required by downstream bioinformatics programs.
Note that at the time of writing, the GridION runs Ubuntu 16.04 LTS, and mounts USB drives in the `/data` folder, and these scripts contain some "faults" to work around these idiosyncrasies.
These scripts are for use with a GridION, to make the files and folder
structures correspond more closely to those required by downstream
bioinformatics programs. Note that at the time of writing, the GridION runs
Ubuntu 16.04 LTS, and mounts USB drives in the `/data` folder, and these scripts
contain some "faults" to work around these idiosyncrasies.
## File Descriptors
## Usage
### `ont-demux`
@ -11,7 +14,11 @@ Note that at the time of writing, the GridION runs Ubuntu 16.04 LTS, and mounts
ont-demux FAP_FOLDER
```
Consolidates all FAST5s into a single gzipped FASTQ using ONT's `guppy_barcoder`. Note that this is for MinKNOW's default settings of 4000 reads/file. It is _highly_ recommended to set the "Number of Reads per File" entry in MinKNOW to 0, and checking "Compress FASTQs" to produce nearly the same results.
Consolidates all FAST5s into a single gzipped FASTQ using ONT's
`guppy_barcoder`. Note that this is for MinKNOW's default settings of 4000
reads/file. It is _highly_ recommended to set the "Number of Reads per File"
entry in MinKNOW to 0, and checking "Compress FASTQs" to produce nearly the same
results.
### `ont-transfer`
@ -19,7 +26,10 @@ Consolidates all FAST5s into a single gzipped FASTQ using ONT's `guppy_barcoder`
ont-transfer [-s 1|6|12] FAP_FOLDER
```
Transfers all of the passing FAST5 and FASTQ files to the first available USB drive, skipping empty barcodes based on the number of the first skip passed through the `-s` parameter, consolidating all files of the same type into one folder for easier sorting and uploading.
Transfers all of the passing FAST5 and FASTQ files to the first available USB
drive, skipping empty barcodes based on the number of the first skip passed
through the `-s` parameter, consolidating all files of the same type into one
folder for easier sorting and uploading.
## Installation
@ -29,7 +39,8 @@ Transfers all of the passing FAST5 and FASTQ files to the first available USB dr
- guppy (Get from [ONT Community](https://nanoporetech.com/community)
- GNU Parallel
See ONT for guppy installation instructions. Others may be installed by opening a terminal and running
See ONT for guppy installation instructions. Others may be installed by opening
a terminal and running
```bash
sudo apt-get install git parallel -y