comparison macros.xml @ 10:e4c01dcece8b draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/salmon commit 26e9f1627e91a4be6bdc7e71cd44f1ea1701ee6f"

9:ecb9ea6269ee

<macros>
    <token name="@VERSION@">1.3.0</token>
    <token name="@GALAXY_VERSION@">galaxy0</token>
    <token name="@IDX_VERSION@">q7</token>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="@VERSION@">salmon</requirement>
            <requirement type="package" version="1.3">seqtk</requirement>
            <requirement type="package" version="1.10">samtools</requirement>
            <requirement type="package" version="0.2.0">vpolo</requirement>
            <requirement type="package" version="1.0.3">pandas</requirement>
            <requirement type="package" version="1.4.1">scipy</requirement>
        </requirements>
    </xml>
    <xml name="stranded">
        <param name="strandedness" type="select" label="Specify the strandedness of the reads">
                <option value="U" selected="True">Not stranded (U)</option>
                <option value="SF">read comes from the forward strand (SF)</option>
                <option value="SR">read comes from the reverse strand (SR)</option>
        </param>
    </xml>
    <xml name="orient">
        <param name="orientation" type="select" label="Relative orientation of reads within a pair">
            <option value="M">Mates are oriented in the same direction (M = matching)</option>
            <option value="O">Mates are oriented away from each other (O = outward)</option>
            <option value="I" selected="True">Mates are oriented toward each other (I = inward)</option>
        </param>
    </xml>
    <xml name="index">
        <conditional name="refTranscriptSource">
            <param name="TranscriptSource" type="select" label="Select a reference transcriptome from your history or use a built-in index?"
                help="Built-ins were indexed using default options">

                    <option value="paired_collection">Paired-end Dataset Collection</option>
                    <option value="paired_interleaved">Paired-end data from single interleaved dataset</option>
                </param>
                <when value="single">
                    <param name="input_singles" type="data" format="fastq,fasta,fastq.gz,fastq.bz2" label="FASTQ/FASTA file" help="FASTQ file." />
                    <expand macro="stranded"/>
                </when>
                <when value="paired">
                    <param name="input_mate1" type="data" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" label="Mate pair 1" help="FASTQ file." />
                    <param name="input_mate2" type="data" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" label="Mate pair 2" help="FASTQ file." />
                    <expand macro="orient"/>
                    <expand macro="stranded"/>
                </when>
                <when value="paired_collection">
                    <param name="input_1" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" type="data_collection" collection_type="paired" label="FASTQ Paired Dataset" help="Must be of datatype &quot;fastqsanger&quot; or &quot;fasta&quot;" />
                    <expand macro="orient"/>
                    <expand macro="stranded"/>
                </when>
                <when value="paired_interleaved">
                   <param name="input_1" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" type="data" label="Interleaved FASTQ file" help="Must be of datatype &quot;fastqsanger&quot; or &quot;fasta&quot;. --interleaved"/>
                   <expand macro="orient"/>
                   <expand macro="stranded"/>
                </when>
            </conditional>
        </section>
        <param argument="--type" type="select" label="Type of index" help="When using quasi, orphaned reads will be considered when performing lightweight-alignment.">
            <option value="quasi" selected="True">quasi</option>

        help="Force hits gathered during quasi-mapping to be 'consistent' (i.e. co-linear and approximately the right distance apart)."/>
        <param name="quasiCoverage" type="integer" optional="True" label="Quasi Coverage"
        help="[Experimental]: The fraction of the read that must be covered by MMPs (of length >= 31) if this read is to be considered as 'mapped'. This may help to avoid 'spurious' mappings. A value of 0 (the default) denotes no coverage threshold (a single 31-mer can yield a mapping). Since coverage by exact matching, large, MMPs is a rather strict condition, this value should likely be set to something low, if used."/>
    </xml>
    <xml name="align">
        <param name="afile" type="data" format="bam" label="Alignment file"/>
        <param name="transcript" type="data" format="fasta,fa" label="Transcript file"/>
        <expand macro="stranded"/>
        <param name="discardOrphans" type="boolean" truevalue="--discardOrphans" falsevalue="" checked="False"
        label="Discard orphans"
        help="Discard orphan alignments in the input. If this flag is passed, then only paired alignments will be considered toward quantification estimates. The default behavior is to consider orphan alignments if no valid paired mappings exist."/>
        <param name="noErrorModel" type="boolean" truevalue="--noErrorModel" falsevalue="" checked="False"
        label="No Error Model"

            help=" The purpose of ignoring the auxiliary models for the first numPreAuxModelSamples observations is to avoid applying these models before thier parameters have been learned sufficiently well." />
            <param name="useEM" type="boolean" truevalue="--useEM" falsevalue="" checked="False"
            label="Use the traditional EM algorithm for optimization in the batch passes."
            help=""/>
            <param name="rangeFactorizationBins" type="integer" value="0" label="Range of factorization bins"
            help="Factorizes the likelihood used in quantification by adopting a new notionof equivalence classes based on the conditional probabilities with which fragments are generated from different transcripts. This is a more fine-grained factorization than the normal rich equivalence classes. The default value (0) corresponds to the standard rich equivalence classes, and larger values imply a more fine-grained factorization. If range factorization is enabled, a common value to select for this parameter is 4."/>
            <param name="numGibbsSamples" type="integer" value="0" optional="True"
            label="Number of Gibbs sampling rounds to perform."
            help="" />
            <param name="noGammaDraw" type="boolean" truevalue="--noGammaDraw" falsevalue="" checked="False"
            label="No gamma draw"

        #end if

        salmon quant
            --index '$index_path'
            #if $quant_type.input.single_or_paired.single_or_paired_opts == 'single':
                --libType ${quant_type.input.single_or_paired.strandedness}
                #if $compressed == 'GZ':
                    --unmatedReads <(zcat < ./single.$ext)
                #else if $compressed == 'BZ2':
                    --unmatedReads <(bzcat < ./single.$ext)
                #else:
                    --unmatedReads ./single.$ext
                #end if
            #else:
                --libType '${quant_type.input.single_or_paired.orientation}${quant_type.input.single_or_paired.strandedness}'
                #if $quant_type.input.single_or_paired.single_or_paired_opts == 'paired_interleaved':
                    #if $compressed == 'BZ2':
                        --mates1 <(bzcat < ./mate1.$ext | seqtk seq -1)
                        --mates2 <(bzcat < ./mate1.$ext | seqtk seq -2)
                    #else:

        #if $geneMap:
            ln -s "$geneMap" ./geneMap.${geneMap.ext} &&
        #end if
        salmon quant
        -t '${quant_type.transcript}'
        -l '${quant_type.strandedness}'
        -a '${quant_type.afile}'
        --threads "\${GALAXY_SLOTS:-4}"
        ${quant_type.discardOrphans}
        ${quant_type.noErrorModel}
        #if $quant_type.numErrorBins:
            --numErrorBins '${quant_type.numErrorBins}'

10:e4c01dcece8b

<macros>
    <token name="@VERSION@">1.5.1</token>
    <token name="@GALAXY_VERSION@">galaxy0</token>
    <token name="@IDX_VERSION@">q7</token>
    <token name="@PROFILE_VERSION@">20.01</token>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="@VERSION@">salmon</requirement>
            <requirement type="package" version="1.3">seqtk</requirement>
            <requirement type="package" version="1.12">samtools</requirement>
            <requirement type="package" version="0.2.0">vpolo</requirement>
            <requirement type="package" version="1.3.0">pandas</requirement>
            <requirement type="package" version="1.7.0">scipy</requirement>
        </requirements>
    </xml>
    <xml name="orient">
        <param name="orientation" type="select" label="Relative orientation of reads within a pair">
            <option value="M">Mates are oriented in the same direction (M = matching)</option>
            <option value="O">Mates are oriented away from each other (O = outward)</option>
            <option value="I" selected="True">Mates are oriented toward each other (I = inward)</option>
        </param>
    </xml>
    <xml name="stranded">
        <conditional name="libtype" >
            <param name="strandedness" type="select" label="Specify the strandedness of the reads" help="--libtype">
                <option value="A" selected="true">Infer automatically (A)</option>
                <option value="U">Not stranded (U)</option>
                <option value="SF">read comes from the forward strand (SF)</option>
                <option value="SR">read comes from the reverse strand (SR)</option>
            </param>
            <yield/>
        </conditional>
    </xml>
    <xml name="stranded_se">
        <expand macro="stranded">
            <when value="A"/>
            <when value="U"/>
            <when value="SF"/>
            <when value="SR"/>
        </expand>
    </xml>
    <xml name="stranded_pe">
        <expand macro="stranded">
            <when value="A">
            </when>
            <when value="U">
                <expand macro="orient"/>
            </when>
            <when value="SF">
                <expand macro="orient"/>
            </when>
            <when value="SR">
                <expand macro="orient"/>
            </when>
        </expand>
    </xml>
    <xml name="index">
        <conditional name="refTranscriptSource">
            <param name="TranscriptSource" type="select" label="Select a reference transcriptome from your history or use a built-in index?"
                help="Built-ins were indexed using default options">

                    <option value="paired_collection">Paired-end Dataset Collection</option>
                    <option value="paired_interleaved">Paired-end data from single interleaved dataset</option>
                </param>
                <when value="single">
                    <param name="input_singles" type="data" format="fastq,fasta,fastq.gz,fastq.bz2" label="FASTQ/FASTA file" help="FASTQ file." />
                    <expand macro="stranded_se"/>
                </when>
                <when value="paired">
                    <param name="input_mate1" type="data" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" label="Mate pair 1" help="FASTQ file." />
                    <param name="input_mate2" type="data" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" label="Mate pair 2" help="FASTQ file." />
                    <expand macro="stranded_pe"/>
                </when>
                <when value="paired_collection">
                    <param name="input_1" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" type="data_collection" collection_type="paired" label="FASTQ Paired Dataset" help="Must be of datatype &quot;fastqsanger&quot; or &quot;fasta&quot;" />
                    <expand macro="stranded_pe"/>
                </when>
                <when value="paired_interleaved">
                   <param name="input_1" format="fastq,fasta,fastq.gz,fastq.bz2,fastqsanger,fastqsanger.gz,fastqsanger.bz2" type="data" label="Interleaved FASTQ file" help="Must be of datatype &quot;fastqsanger&quot; or &quot;fasta&quot;. --interleaved"/>
                   <expand macro="stranded_pe"/>
                </when>
            </conditional>
        </section>
        <param argument="--type" type="select" label="Type of index" help="When using quasi, orphaned reads will be considered when performing lightweight-alignment.">
            <option value="quasi" selected="True">quasi</option>

        help="Force hits gathered during quasi-mapping to be 'consistent' (i.e. co-linear and approximately the right distance apart)."/>
        <param name="quasiCoverage" type="integer" optional="True" label="Quasi Coverage"
        help="[Experimental]: The fraction of the read that must be covered by MMPs (of length >= 31) if this read is to be considered as 'mapped'. This may help to avoid 'spurious' mappings. A value of 0 (the default) denotes no coverage threshold (a single 31-mer can yield a mapping). Since coverage by exact matching, large, MMPs is a rather strict condition, this value should likely be set to something low, if used."/>
    </xml>
    <xml name="align">
        <param name="afile" type="data" format="qname_input_sorted.bam,qname_sorted.bam" label="Alignment file"/>
        <param argument="--ont" type="boolean" truevalue="--ont" falsevalue="" label="Is this Alignment file a Oxford Nanopore Technologies (ONT) dataset ?" help="Select this for both cDNA and direct RNA ONT datasets. Enables an alignment error model designed to work with long-read alignments and disables the length effect in the generative model when computing the conditional probability of observing a fragment given that it arises from a specific transcript. This is because in long-read sequencing, we do not expect to observe (i.e. sequence) multiple fragments from the same molecule, and thus we do not expect the transcript length to directly affect the observed fragment count directly"/>
        <param name="transcript" type="data" format="fasta,fa" label="Transcript file"/>
        <expand macro="stranded_se"/>
        <param name="discardOrphans" type="boolean" truevalue="--discardOrphans" falsevalue="" checked="False"
        label="Discard orphans"
        help="Discard orphan alignments in the input. If this flag is passed, then only paired alignments will be considered toward quantification estimates. The default behavior is to consider orphan alignments if no valid paired mappings exist."/>
        <param name="noErrorModel" type="boolean" truevalue="--noErrorModel" falsevalue="" checked="False"
        label="No Error Model"

            help=" The purpose of ignoring the auxiliary models for the first numPreAuxModelSamples observations is to avoid applying these models before thier parameters have been learned sufficiently well." />
            <param name="useEM" type="boolean" truevalue="--useEM" falsevalue="" checked="False"
            label="Use the traditional EM algorithm for optimization in the batch passes."
            help=""/>
            <param name="rangeFactorizationBins" type="integer" value="0" label="Range of factorization bins"
            help="Factorizes the likelihood used in quantification by adopting a new notion of equivalence classes based on the conditional probabilities with which fragments are generated from different transcripts. This is a more fine-grained factorization than the normal rich equivalence classes. The default value (0) corresponds to the standard rich equivalence classes, and larger values imply a more fine-grained factorization. If range factorization is enabled, a common value to select for this parameter is 4."/>
            <param name="numGibbsSamples" type="integer" value="0" optional="True"
            label="Number of Gibbs sampling rounds to perform."
            help="" />
            <param name="noGammaDraw" type="boolean" truevalue="--noGammaDraw" falsevalue="" checked="False"
            label="No gamma draw"

        #end if

        salmon quant
            --index '$index_path'
            #if $quant_type.input.single_or_paired.single_or_paired_opts == 'single':
                --libType ${quant_type.input.single_or_paired.libtype.strandedness}
                #if $compressed == 'GZ':
                    --unmatedReads <(zcat < ./single.$ext)
                #else if $compressed == 'BZ2':
                    --unmatedReads <(bzcat < ./single.$ext)
                #else:
                    --unmatedReads ./single.$ext
                #end if
            #else:
                --libType
                #if $quant_type.input.single_or_paired.libtype.strandedness == 'A'
                    A
                #else
                    ${quant_type.input.single_or_paired.libtype.orientation}${quant_type.input.single_or_paired.libtype.strandedness}
                #end if
                #if $quant_type.input.single_or_paired.single_or_paired_opts == 'paired_interleaved':
                    #if $compressed == 'BZ2':
                        --mates1 <(bzcat < ./mate1.$ext | seqtk seq -1)
                        --mates2 <(bzcat < ./mate1.$ext | seqtk seq -2)
                    #else:

        #if $geneMap:
            ln -s "$geneMap" ./geneMap.${geneMap.ext} &&
        #end if
        salmon quant
        -t '${quant_type.transcript}'
        -l '${quant_type.libtype.strandedness}'
        -a '${quant_type.afile}'
        $quant_type.ont
        --threads "\${GALAXY_SLOTS:-4}"
        ${quant_type.discardOrphans}
        ${quant_type.noErrorModel}
        #if $quant_type.numErrorBins:
            --numErrorBins '${quant_type.numErrorBins}'