Repository revision
31:3aae4f16ac9e

Repository 'snpeff'
hg clone https://toolshed.g2.bx.psu.edu/repos/iuc/snpeff

SnpEff eff: tool metadata
Miscellaneous
SnpEff eff:
annotate variants
snpEff
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/5.2+galaxy1
5.2+galaxy1
snpEff -version
True
Version lineage of this tool (guids ordered most recent to oldest)
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/5.2+galaxy1 (this tool)
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/5.2+galaxy0
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/4.3+T.galaxy2
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/4.3+T.galaxy1
toolshed.g2.bx.psu.edu/repos/iuc/snpeff/snpEff/3.4
snpEff
Requirements (dependencies defined in the <requirements> tag set)
name version type
snpeff 5.2 package
coreutils 9.5 package
Additional information about this tool
#if $intervals 
            ln -s '${intervals}' intervals.bed &&
        #end if 
        snpEff -Xmx\${GALAXY_MEMORY_MB:-8192}m eff
        -i $inputFormat -o ${outputFormat} -upDownStreamLen $udLength
        #if $spliceSiteSize and str($spliceSiteSize) != '':
          -spliceSiteSize "$spliceSiteSize"
        #end if
        #if $spliceRegion.setSpliceRegions == 'yes':
          #if str($spliceRegion.spliceRegionExonSize)
            -spliceRegionExonSize $spliceRegion.spliceRegionExonSize
          #end if
          #if str($spliceRegion.spliceRegionIntronMin)
            -spliceRegionIntronMin $spliceRegion.spliceRegionIntronMin
          #end if
          #if str($spliceRegion.spliceRegionIntronMax)
            -spliceRegionIntronMax $spliceRegion.spliceRegionIntronMax
          #end if
        #end if
        #if $annotations and str($annotations) != '':
          #echo " "
          #echo ' '.join(str($annotations).split(','))
        #end if
        #if $filterOut and str($filterOut) != '':
          #echo " "
          #echo ' '.join(str($filterOut).split(','))
        #end if
        #if $filter.specificEffects == 'yes' and $filter.effects:
          #for $eff in str($filter.effects).split(','):
            -no $eff
          #end for
        #end if
        #if $transcripts
          -onlyTr '$transcripts'
        #end if
        #if $intervals     ### fix this for multiple dataset input
          -interval intervals.bed
        #end if
        #if str($chr).strip() != '':
          -chr '$chr'
        #end if
        #if $generate_stats or $generate_gene_stats or $csvStats:
          #if $csvStats:
            $csvStats snpeff_stats.csv
          #end if
          #if $generate_stats or ($generate_gene_stats and not $csvStats):
            ## the base name passed in via the -csvStats or the -s option also determines the name of the genes.txt file
            ## so in the absence of the first we need the second to have a consistent name of the genes.txt file
            -s snpeff_stats.html
          #end if
        #else:
          ## when no stats output is requested by the user, we can make things a little more efficient
          ## by telling snpEff that it doesn't have to write even the default (html and genes.txt) ones.
          -noStats
        #end if
          $noLog
        ## Regulation names can include parentheses: H3K4me3-MSC_(VB)_enriched_sites
        ## Enclose them in in single and double quotes, as the conda snpEff bash script will remove outer quotes
        #if $snpDb.genomeSrc == 'cached':
          -dataDir ${snpDb.genomeVersion.fields.path}
          #if $snpDb.reg_section.regulation and str($snpDb.reg_section.regulation) != '':
            #set $regs = [x for x in str($snpDb.reg_section.regulation).split(',')]
            #for reg in $regs:
              -reg '"${reg}"'
            #end for
          #end if
          $snpDb.genomeVersion
        #elif $snpDb.genomeSrc == 'history':
          -dataDir '${snpDb.snpeff_db.extra_files_path}'
          #if $snpDb.reg_section.regulation and str($snpDb.reg_section.regulation) != '':
            #set $regs = [x for x in str($snpDb.reg_section.regulation).split(',')]
            #for reg in $regs:
              -reg '"${reg}"'
            #end for
          #end if
          '${snpDb.snpeff_db.metadata.genome_version}'
        #elif $snpDb.genomeSrc == 'custom':
            -dataDir '${snpDb.snpeff_db.extra_files_path}'
            -configOption '${snpDb.snpeff_db.metadata.genome_version}'.genome='${snpDb.snpeff_db.metadata.genome_version}'
            -configOption '${snpDb.snpeff_db.metadata.genome_version}'.codonTable='${snpDb.codon_table}'
            '${snpDb.snpeff_db.metadata.genome_version}'
        #else
          -dataDir "\$PWD/temp"
          -download
          '$snpDb.genome_version'
        #end if
        '$input' > '$snpeff_output'
        #if $generate_gene_stats:
          ## remove the first, unnecessary comment line from the output
          && tail -n+2 snpeff_stats.genes.txt > genes.txt
        #end if
        #if $generate_stats:
          ## independently of whether the user asked for the gene.txt file,
          ## we need to add it to files_path because the stats html report links to it.
          && mkdir '$statsFile.files_path' &&
          mv snpeff_stats.genes.txt $statsFile.files_path
        #end if
    
None
False
Functional tests
name inputs outputs required files
Test-1 input: input.vcf
inputFormat: vcf
outputFormat: vcf
generate_stats: False
snpDb|genomeVersion: ebola_zaire
snpDb|genomeSrc: cached
udLength: 0
name: value
input.vcf
value
Test-2 input: input.vcf
inputFormat: vcf
outputFormat: vcf
snpDb|genomeVersion: ebola_zaire
snpDb|genomeSrc: cached
udLength: 0
name: value
name: value
input.vcf
value
Test-3 input: input.vcf
inputFormat: vcf
outputFormat: vcf
generate_stats: False
generate_gene_stats: True
snpDb|genomeVersion: ebola_zaire
snpDb|genomeSrc: cached
udLength: 0
name: value
name: value
input.vcf
value
Test-4 input: input.vcf
inputFormat: vcf
outputFormat: vcf
csvStats: True
generate_stats: False
snpDb|genomeVersion: ebola_zaire
snpDb|genomeSrc: cached
udLength: 0
intervals: intervals.bed
name: value
name: value
input.vcf
intervals.bed
value