annotate falco.xml @ 1:0f4aadf6988c draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
author iuc
date Tue, 10 Sep 2024 19:02:22 +0000
parents 40c04ab0d17d
children 2b29a20e9869
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
1 <tool id="falco" name="Falco" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="21.05">
0
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
2 <description>An alternative, more performant implementation of FastQC for high throughput sequence quality control</description>
1
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
3 <macros>
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
4 <token name="@TOOL_VERSION@">1.2.3</token>
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
5 <token name="@VERSION_SUFFIX@">0</token>
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
6 </macros>
0
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
7 <xrefs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
8 <xref type="bio.tools">falco</xref>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
9 </xrefs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
10 <requirements>
1
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
11 <requirement type="package" version="@TOOL_VERSION@">falco</requirement>
0
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
12 </requirements>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
13 <command detect_errors="aggressive"><![CDATA[
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
14 #import re
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
15 #set input_name_sl = re.sub('[^\w\-\s]', '_', str($input_file.element_identifier))
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
16
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
17 #if 'bam' in $input_file.ext:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
18 #set format = 'bam'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
19 #elif 'sam' in $input_file.ext:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
20 #set format = 'sam'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
21 #elif 'gz' in $input_file.ext:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
22 #set format = 'fastq.gz'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
23 #else
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
24 #set format = 'fastq'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
25 #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
26
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
27 ln -s '${input_file}' '${input_name_sl}' &&
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
28 falco
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
29 #if $contaminants:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
30 --contaminants '${contaminants}'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
31 #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
32
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
33 #if $adapters.dataset and str($adapters) > ''
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
34 --adapters '${adapters}'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
35 #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
36
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
37 #if $limits.dataset and str($limits) > ''
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
38 --limits '${limits}'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
39 #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
40 --threads \${GALAXY_SLOTS:-2}
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
41 --quiet
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
42 ## #if $min_length:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
43 ## --min_length $min_length
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
44 ## #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
45 $nogroup
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
46 ## --kmers $kmers
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
47 -f '${format}'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
48 '${input_name_sl}'
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
49 #if $subsample > 1:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
50 -subsample $subsample
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
51 #end if
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
52 $bisulfite
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
53 $reverse_complement
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
54 $generate_summary
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
55 ]]></command>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
56 <inputs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
57 <param format="fastq,fastq.gz,bam,sam" name="input_file" type="data" label="Raw read data from your current history"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
58 <param name="contaminants" type="data" format="tabular" optional="true" label="Contaminant list" help="tab delimited file with 2 columns: name and sequence. For example: Illumina Small RNA RT Primer&#x9;CAAGCAGAAGACGGCATACGA"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
59 <param argument="--adapters" type="data" format="tabular" optional="true" label="Adapter list" help="List of adapters adapter sequences which will be explicity searched against the library. It should be a tab-delimited file with 2 columns: name and sequence."/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
60 <param name="limits" type="data" format="txt" optional="true" label="Submodule and Limit specifing file" help="a file that specifies which submodules are to be executed (default=all) and also specifies the thresholds for the each submodules warning parameter."/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
61 <param argument="--nogroup" type="boolean" truevalue="--nogroup" falsevalue="" checked="False" label="Disable grouping of bases for reads &gt;50bp" help=" Using this option, your plots may end up a ridiculous size. You have been warned!"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
62 <!-- Not implemented in falco yet <param argument="-min_length" type="integer" value="" optional="true" label="Lower limit on the length of the sequence to be shown in the report" help=" [NOT YET IMPLEMENTED IN FALCO]. Sets an artificial lower limit on the length of the sequence to be shown in the report. As long as you set this to a value greater or equal to your longest read length then this will be the sequence length used to create your read groups. This can be useful for making directly comaparable statistics from datasets with somewhat variable read length."/> -->
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
63 <!-- Ignored by falco and always set to 7 <param argument="-kmers" type="integer" value="7" min="2" max="10" label="Length of Kmer to look for" help="IGNORED BY FALCO AND ALWAYS SET TO 7. Specifies the length of Kmer to look for in the Kmer content module. Specified Kmer length must be between 2 and 10. Default length is 7 if not specified." /> -->
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
64 <param argument="-subsample" type="integer" value="1" min="1" label="Subsampling Factor" help="This makes falco faster (but possibly less accurate) by only processing reads that are multiple of this value (using 0-based indexing to number reads)"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
65 <param argument="-bisulfite" type="boolean" truevalue="-bisulfite" falsevalue="" checked="False" label="Bisulfite Sequencing" help="This parameter indicates whether the reads are from whole genome bisulfite sequencing. When enabled, Falco will account for the expected increase in Ts and decrease in Cs in the base content."/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
66 <param argument="reverse_complement" type="boolean" truevalue="-reverse-complement" falsevalue="" checked="False" label="Reverse Complement" help="This parameter specifies whether the input sequences are reverse-complemented. When enabled, all modules in Falco will be tested by swapping A/T and C/G."/>
1
0f4aadf6988c planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit 900be4eec6ed42fd9addf229406458bb75e3d69b
iuc
parents: 0
diff changeset
67 <param name="generate_summary" type="boolean" truevalue="" falsevalue="-skip-summary" checked="False" label="Generate summary output of QC test results"/>
0
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
68 </inputs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
69 <outputs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
70 <data format="html" name="html_file" from_work_dir="fastqc_report.html" label="${tool.name} on ${on_string}: Webpage"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
71 <data format="txt" name="text_file" from_work_dir="fastqc_data.txt" label="${tool.name} on ${on_string}: RawData"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
72 <data format="txt" name="summary_file" from_work_dir="summary.txt" label="${tool.name} on ${on_string}: SummaryData">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
73 <filter>generate_summary</filter>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
74 </data>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
75 </outputs>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
76 <tests>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
77 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
78 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
79 <output name="html_file" file="fastqc_report.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
80 <output name="text_file" file="fastqc_data.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
81 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
82 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
83 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
84 <param name="contaminants" value="contaminant_list.txt" ftype="tabular"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
85 <output name="html_file" file="fastqc_report_contaminants.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
86 <output name="text_file" file="fastqc_data_contaminants.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
87 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
88 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
89 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
90 <param name="adapters" value="adapter_list.txt" ftype="tabular"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
91 <output name="html_file" file="fastqc_report_adapters.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
92 <output name="text_file" file="fastqc_data_adapters.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
93 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
94 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
95 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
96 <param name="limits" value="limits.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
97 <output name="html_file" file="fastqc_report_customlimits.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
98 <output name="text_file" file="fastqc_data_customlimits.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
99 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
100 <!-- ## The kmers param is ignored in Falco and always set to 7. If this ever gets reconsidered, this test could be uncommented.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
101 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
102 <param name="input_file" value="1000trimmed.fastq" ftype="fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
103 <param name="kmers" value="7"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
104 <param name="limits" value="limits.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
105 <output name="html_file" file="fastqc_report_kmer.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
106 <output name="text_file" file="fastqc_data_kmer.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
107 <assert_command>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
108 <has_text text="kmers 7"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
109 </assert_command>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
110 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
111 ## The min_length param is not yet implemented in Falco.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
112 Once it is, this test may be uncommented.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
113 <test expect_num_outputs="2">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
114 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
115 <param name="min_length" value="108"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
116 <output name="html_file" file="fastqc_report_min_length.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
117 <output name="text_file" file="fastqc_data_min_length.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
118 </test> -->
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
119 <test expect_num_outputs="3">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
120 <param name="input_file" value="1000trimmed.fastq" ftype="fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
121 <param name="nogroup" value="--nogroup"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
122 <param name="generate_summary" value="true"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
123 <output name="html_file" file="fastqc_report_nogroup.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
124 <output name="text_file" file="fastqc_data_nogroup.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
125 <output name="summary_file" file="fastqc_data_nogroup_summary.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
126 <assert_command>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
127 <has_text text="--nogroup"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
128 </assert_command>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
129 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
130 <test expect_num_outputs="3">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
131 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
132 <param name="subsample" value="10"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
133 <param name="generate_summary" value="true"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
134 <output name="html_file" file="fastqc_report_subsample.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
135 <output name="text_file" file="fastqc_report_subsample.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
136 <output name="summary_file" file="fastqc_report_subsample_summary.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
137 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
138 <test expect_num_outputs="3">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
139 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
140 <param name="bisulfite" value="-bisulfite"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
141 <param name="generate_summary" value="true"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
142 <output name="html_file" file="fastqc_report_bisulfite.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
143 <output name="text_file" file="fastqc_report_bisulfite.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
144 <output name="summary_file" file="fastqc_report_bisulfite_summary.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
145 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
146 <test expect_num_outputs="3">
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
147 <param name="input_file" value="1000trimmed.fastq"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
148 <param name="reverse_complement" value="-reverse-complement"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
149 <param name="generate_summary" value="true"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
150 <output name="html_file" file="fastqc_report_reverse_complement.html" ftype="html" lines_diff="2"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
151 <output name="text_file" file="fastqc_report_reverse_complement.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
152 <output name="summary_file" file="fastqc_report_reverse_complement_summary.txt" ftype="txt"/>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
153 </test>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
154 </tests>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
155 <help><![CDATA[
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
156 **What it does**
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
157
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
158 Falco_ is a high-speed emulation of the popular FastQC software for quality control of sequencing data.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
159
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
160 💚️ With its superior performance Falco saves computational resources and gives you back results faster than FastQC.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
161
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
162 We recommend it for most use cases (but see below for exceptions). 💚️
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
163
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
164 The main functions of Falco are very similar to those of FastQC:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
165
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
166 - Import of data from BAM, SAM or FastQ/FastQ.gz files (any variant),
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
167 - Providing a quick overview to tell you in which areas there may be problems
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
168 - Summary graphs and tables to quickly assess your data
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
169 - Export of results to an HTML based permanent report
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
170 - Offline operation to allow automated generation of reports without running the interactive application
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
171
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
172 .. class:: infomark
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
173
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
174 The plain text report generated by Falco can be used as a "FastQC" report in MultiQC and its data is very similar though not 100% identical to that generated by FastQC on the same inputs.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
175
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
176 .. class:: Warning mark
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
177
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
178 In the following situations, FastQC is still a better solution than this version of Falco:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
179
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
180 - your input is bz2-compressed fastq
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
181
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
182 Falco doesn't currently support fastq.bz2 as input format meaning Galaxy has to perform a relatively slow format conversion before running the tool, which together makes the analysis slower than with FastQC.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
183
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
184 - you are interested in PolyA and PolyG statistics in the Adapter Content section of the quality report
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
185
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
186 Falco doesn't currently calculate statistics for these "Adapters" by default.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
187
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
188 - your input consists of *mapped* reads in SAM/BAM format
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
189
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
190 Due to a bug in the current version of Falco, reads mapped to the reverse strand of the reference genome are not handled correctly and reported metrics are wrong!
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
191
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
192 -----
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
193
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
194 **Inputs and outputs**
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
195
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
196 The Falco_ development repo includes very good documentation.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
197 A summary of it follows below for those in a tearing hurry.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
198
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
199 This wrapper will accept a Galaxy fastq, fastq.gz, sam or bam as the input read file to check.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
200 It will also take an optional file containing a list of contaminants information, in the form of
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
201 a tab-delimited file with 2 columns, name and sequence. As another option the tool takes a custom
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
202 limits.txt file that allows setting the warning thresholds for the different modules and also specifies
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
203 which modules to include in the output.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
204
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
205 The tool produces a basic text and a HTML output file that contain all of the results, including the following:
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
206
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
207 - Basic Statistics
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
208 - Per base sequence quality
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
209 - Per sequence quality scores
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
210 - Per base sequence content
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
211 - Per base GC content
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
212 - Per sequence GC content
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
213 - Per base N content
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
214 - Sequence Length Distribution
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
215 - Sequence Duplication Levels
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
216 - Overrepresented sequences
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
217 - Adapter Content
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
218
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
219 All except Basic Statistics and Overrepresented sequences are plots.
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
220 .. _Falco: https://github.com/smithlabcode/falco/
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
221 ]]></help>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
222 <citations>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
223 <citation type="doi">10.12688/f1000research.21142.2</citation>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
224 </citations>
40c04ab0d17d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/falco commit e1af25e42839c772b023f700210013658e42dc15
iuc
parents:
diff changeset
225 </tool>