Skip to content

Commit 6a3c115

Browse files
author
Jon Palmer
committed
update docs and bump version to 1.4.1
1 parent d58878e commit 6a3c115

File tree

3 files changed

+59
-57
lines changed

3 files changed

+59
-57
lines changed

docs/annotate.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,16 +51,16 @@ Similarily to :code:`funannotate predict`, the output from :code:`funannotate an
5151
$ funannotate annotate
5252
5353
Usage: funannotate annotate <arguments>
54-
version: 1.4.0-10f90df
54+
version: 1.4.1
5555
5656
Description: Script functionally annotates the results from funannotate predict. It pulls
5757
annotation from PFAM, InterPro, EggNog, UniProtKB, MEROPS, CAZyme, and GO ontology.
5858
5959
Required: -i, --input Folder from funannotate predict
60-
or
60+
6161
--genbank Genome in GenBank format
6262
-o, --out Output folder for results
63-
or
63+
6464
--gff Genome GFF3 annotation file
6565
--fasta Genome in multi-fasta format
6666
-s, --species Species name, use quotes for binomial, e.g. "Aspergillus fumigatus"

docs/commands.rst

+53-52
Original file line numberDiff line numberDiff line change
@@ -223,58 +223,59 @@ all of the data present. Finally, the GFF3 file is converted to NCBI GenBank for
223223
.. code-block:: none
224224
225225
Usage: funannotate predict <arguments>
226-
version: 1.4.0
227-
228-
Description: Script takes genome multi-fasta file and a variety of inputs to do a comprehensive whole
229-
genome gene prediction. Uses AUGUSTUS, GeneMark, BUSCO, BRAKER, EVidence Modeler,
230-
tbl2asn, tRNAScan-SE, Exonerate, minimap2.
231-
232-
Required: -i, --input Genome multi-FASTA file (softmasked repeats).
233-
-o, --out Output folder name.
234-
-s, --species Species name, use quotes for binomial, e.g. "Aspergillus fumigatus"
235-
236-
Optional: --isolate Isolate name, e.g. Af293
237-
--strain Strain name, e.g. FGSCA4
238-
--name Locus tag name (assigned by NCBI?). Default: FUN_
239-
--numbering Specify where gene numbering starts. Default: 1
240-
--maker_gff MAKER2 GFF file. Parse results directly to EVM.
241-
--pasa_gff PASA generated gene models. filename:weight
242-
--other_gff Annotation pass-through to EVM. filename:weight
243-
--rna_bam RNA-seq mapped to genome to train Augustus/GeneMark-ET
244-
--augustus_species Augustus species config. Default: uses species name
245-
--genemark_mode GeneMark mode. Default: ES [ES,ET]
246-
--genemark_mod GeneMark ini mod file.
247-
--busco_seed_species Augustus pre-trained species to start BUSCO. Default: anidulans
248-
--optimize_augustus Run 'optimze_augustus.pl' to refine training (long runtime)
249-
--busco_db BUSCO models. Default: dikarya. `funannotate outgroups --show_buscos`
250-
--organism Fungal-specific options. Default: fungus. [fungus,other]
251-
--ploidy Ploidy of assembly. Default: 1
252-
-t, --tbl2asn Assembly parameters for tbl2asn. Example: "-l paired-ends"
253-
-d, --database Path to funannotate database. Default: $FUNANNOTATE_DB
254-
255-
--protein_evidence Proteins to map to genome (prot1.fa prot2.fa uniprot.fa). Default: uniprot.fa
256-
--protein_alignments Pre-computed exonerate protein alignments (see docs for format)
257-
--transcript_evidence mRNA/ESTs to align to genome (trans1.fa ests.fa trinity.fa). Default: none
258-
--transcript_alignments Pre-computed transcript alignments in GFF3 format
259-
--augustus_gff Pre-computed AUGUSTUS GFF3 results (must use --stopCodonExcludedFromCDS=False)
260-
--genemark_gtf Pre-computed GeneMark GTF results
261-
262-
--min_intronlen Minimum intron length. Default: 10
263-
--max_intronlen Maximum intron length. Default: 3000
264-
--soft_mask Softmasked length threshold for GeneMark. Default: 5000
265-
--min_protlen Minimum protein length. Default: 50
266-
--repeat_filter Repetitive gene model filtering. Default: overlap blast [overlap,blast,none]
267-
--keep_no_stops Keep gene models without valid stops.
268-
--SeqCenter Sequencing facilty for NCBI tbl file. Default: CFMR
269-
--SeqAccession Sequence accession number for NCBI tbl file. Default: 12345
270-
--force Annotated unmasked genome.
271-
--cpus Number of CPUs to use. Default: 2
272-
273-
ENV Vars: If not specified at runtime, will be loaded from your $PATH
274-
--EVM_HOME
275-
--AUGUSTUS_CONFIG_PATH
276-
--GENEMARK_PATH
277-
--BAMTOOLS_PATH
226+
version: 1.4.1
227+
228+
Description: Script takes genome multi-fasta file and a variety of inputs to do a comprehensive whole
229+
genome gene prediction. Uses AUGUSTUS, GeneMark, BUSCO, BRAKER, EVidence Modeler,
230+
tbl2asn, tRNAScan-SE, Exonerate, minimap2.
231+
232+
Required: -i, --input Genome multi-FASTA file (softmasked repeats).
233+
-o, --out Output folder name.
234+
-s, --species Species name, use quotes for binomial, e.g. "Aspergillus fumigatus"
235+
236+
Optional: --isolate Isolate name, e.g. Af293
237+
--strain Strain name, e.g. FGSCA4
238+
--name Locus tag name (assigned by NCBI?). Default: FUN_
239+
--numbering Specify where gene numbering starts. Default: 1
240+
--maker_gff MAKER2 GFF file. Parse results directly to EVM.
241+
--pasa_gff PASA generated gene models. filename:weight
242+
--other_gff Annotation pass-through to EVM. filename:weight
243+
--rna_bam RNA-seq mapped to genome to train Augustus/GeneMark-ET
244+
--augustus_species Augustus species config. Default: uses species name
245+
--genemark_mode GeneMark mode. Default: ES [ES,ET]
246+
--genemark_mod GeneMark ini mod file.
247+
--busco_seed_species Augustus pre-trained species to start BUSCO. Default: anidulans
248+
--optimize_augustus Run 'optimze_augustus.pl' to refine training (long runtime)
249+
--busco_db BUSCO models. Default: dikarya. `funannotate outgroups --show_buscos`
250+
--organism Fungal-specific options. Default: fungus. [fungus,other]
251+
--ploidy Ploidy of assembly. Default: 1
252+
-t, --tbl2asn Assembly parameters for tbl2asn. Example: "-l paired-ends"
253+
-d, --database Path to funannotate database. Default: $FUNANNOTATE_DB
254+
255+
--protein_evidence Proteins to map to genome (prot1.fa prot2.fa uniprot.fa). Default: uniprot.fa
256+
--protein_alignments Pre-computed exonerate protein alignments (see docs for format)
257+
--transcript_evidence mRNA/ESTs to align to genome (trans1.fa ests.fa trinity.fa). Default: none
258+
--transcript_alignments Pre-computed transcript alignments in GFF3 format
259+
--augustus_gff Pre-computed AUGUSTUS GFF3 results (must use --stopCodonExcludedFromCDS=False)
260+
--genemark_gtf Pre-computed GeneMark GTF results
261+
262+
--min_intronlen Minimum intron length. Default: 10
263+
--max_intronlen Maximum intron length. Default: 3000
264+
--soft_mask Softmasked length threshold for GeneMark. Default: 2000
265+
--min_protlen Minimum protein length. Default: 50
266+
--repeats2evm Use repeats in EVM consensus model building.
267+
--repeat_filter Repetitive gene model filtering. Default: overlap blast [overlap,blast,none]
268+
--keep_no_stops Keep gene models without valid stops.
269+
--SeqCenter Sequencing facilty for NCBI tbl file. Default: CFMR
270+
--SeqAccession Sequence accession number for NCBI tbl file. Default: 12345
271+
--force Annotated unmasked genome.
272+
--cpus Number of CPUs to use. Default: 2
273+
274+
ENV Vars: If not specified at runtime, will be loaded from your $PATH
275+
--EVM_HOME
276+
--AUGUSTUS_CONFIG_PATH
277+
--GENEMARK_PATH
278+
--BAMTOOLS_PATH
278279
279280
funannotate fix
280281
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

funannotate.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def fmtcols(mylist, cols):
3737
pass
3838

3939
git_version = lib.git_version()
40-
base_version = '1.4.0'
40+
base_version = '1.4.1'
4141
if git_version:
4242
version = base_version+'-'+git_version
4343
else:
@@ -255,8 +255,9 @@ def fmtcols(mylist, cols):
255255
256256
--min_intronlen Minimum intron length. Default: 10
257257
--max_intronlen Maximum intron length. Default: 3000
258-
--soft_mask Softmasked length threshold for GeneMark. Default: 5000
258+
--soft_mask Softmasked length threshold for GeneMark. Default: 2000
259259
--min_protlen Minimum protein length. Default: 50
260+
--repeats2evm Use repeats in EVM consensus model building.
260261
--repeat_filter Repetitive gene model filtering. Default: overlap blast [overlap,blast,none]
261262
--keep_no_stops Keep gene models without valid stops.
262263
--SeqCenter Sequencing facilty for NCBI tbl file. Default: CFMR

0 commit comments

Comments
 (0)