Skip to content

Commit

Permalink
Add an issue template.
Browse files Browse the repository at this point in the history
  • Loading branch information
brianwalenz committed May 17, 2017
1 parent 90e69a6 commit f95c9cf
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -0,0 +1,21 @@
**Remove this text before submitting your issue!**

Include the canu command used, or at least tell us what options you've set.

Include the output of `canu -version` if it isn't in any outputs. It's reported at the start of the logging, and just before any crash report.

Include what system you're running on. MacOS, Linux, or other? In a virtual machine? On a grid?

FORMATTING TIPS:

Use `single backtics` to highlight words in text.
```
Use triple backtics surrounding any pasted-in text.
This preserves
any
bizarre
formatting
```
Use the `Preview` button just above this space to see what the issue will look like.

**Remove this text before submitting your issue!**

1 comment on commit f95c9cf

@jccolon84
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi all, Im trying to run the following #######SLURM:

#!/bin/bash
#SBATCH --job-name=canu
#SBATCH --output=canu.out
#SBATCH --error=canu.err
#SBATCH --nodes=1
#SBATCH --mem=150G
#SBATCH --mail-user=
#SBATCH --mail-type=begin
#SBATCH --mail-type=end

#####################################

canu -p apio -d apio_assembly genomeSize=1G -pacbio-raw PLAtfscDAPIO_LEAF.subreads.fastq.gz minReadLength=1000 maxMemory=500 maxThreads=25

When it run, this message appear:

usage: canu [-version] [-citation]
[-haplotype | -correct | -trim | -assemble | -trim-assemble]
[-s ]
-p
-d
genomeSize=[g|m|k]
[other-options]
[-haplotype{NAME} illumina.fastq.gz]
[-corrected]
[-trimmed]
[-pacbio |
-nanopore |
-pacbio-hifi] file1 file2 ...

example: canu -d run1 -p godzilla genomeSize=1g -nanopore-raw reads/*.fasta.gz

To restrict canu to only a specific stage, use:
-haplotype - generate haplotype-specific reads
-correct - generate corrected reads
-trim - generate trimmed reads
-assemble - generate an assembly
-trim-assemble - generate trimmed reads and then assemble them

The assembly is computed in the -d , with output files named
using the -p . This directory is created if needed. It is not
possible to run multiple assemblies in the same directory.

The genome size should be your best guess of the haploid genome size of what is being
assembled. It is used primarily to estimate coverage in reads, NOT as the desired
assembly size. Fractional values are allowed: '4.7m' equals '4700k' equals '4700000'

Some common options:
useGrid=string
- Run under grid control (true), locally (false), or set up for grid control
but don't submit any jobs (remote)
rawErrorRate=fraction-error
- The allowed difference in an overlap between two raw uncorrected reads. For lower
quality reads, use a higher number. The defaults are 0.300 for PacBio reads and
0.500 for Nanopore reads.
correctedErrorRate=fraction-error
- The allowed difference in an overlap between two corrected reads. Assemblies of
low coverage or data with biological differences will benefit from a slight increase
in this. Defaults are 0.045 for PacBio reads and 0.144 for Nanopore reads.
gridOptions=string
- Pass string to the command used to submit jobs to the grid. Can be used to set
maximum run time limits. Should NOT be used to set memory limits; Canu will do
that for you.
minReadLength=number
- Ignore reads shorter than 'number' bases long. Default: 1000.
minOverlapLength=number
- Ignore read-to-read overlaps shorter than 'number' bases long. Default: 500.
A full list of options can be printed with '-options'. All options can be supplied in
an optional sepc file with the -s option.

For TrioCanu, haplotypes are specified with the -haplotype{NAME} option, with any
number of haplotype-specific Illumina read files after. The {NAME} of each haplotype
is free text (but only letters and numbers, please). For example:
-haplotypeNANNY nanny/*gz
-haplotypeBILLY billy1.fasta.gz billy2.fasta.gz

Reads can be either FASTA or FASTQ format, uncompressed, or compressed with gz, bz2 or xz.

Reads are specified by the technology they were generated with, and any processing performed.

[processing]
-corrected
-trimmed

[technology]
-pacbio
-nanopore
-pacbio-hifi

Complete documentation at http://canu.readthedocs.org/en/latest/

ERROR: Invalid command line option 'PLAtfscDAPIO_LEAF.subreads.fastq.gz'. Did you forget quotes around options with spaces?

I dont know what I'm doing wrong.

Please sign in to comment.