Mercurial > repos > oinizan > frogs_2_0_0
changeset 6:ccc589935dd8 draft
planemo upload commit f2e9d60ee5915e917083688cdc0d6f5d78f98028-dirty
| author | oinizan |
|---|---|
| date | Thu, 05 Apr 2018 10:24:34 -0400 |
| parents | dd2c9c4ed207 |
| children | eb18eadd20c3 |
| files | upload_tar.xml |
| diffstat | 1 files changed, 201 insertions(+), 77 deletions(-) [+] |
line wrap: on
line diff
--- a/upload_tar.xml Thu Apr 05 10:21:28 2018 -0400 +++ b/upload_tar.xml Thu Apr 05 10:24:34 2018 -0400 @@ -1,93 +1,217 @@ <?xml version="1.0"?> -<!-- -# Copyright (C) 2015 INRA -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. ---> -<tool id="FROGS_upload_tar" name="FROGS Upload archive" version="1.1.0" workflow_compatible="false"> - <description>from your computer</description> - <action module="galaxy.tools.actions.upload" class="UploadToolAction"/> - <requirements> - <requirement type="package" version="2.0.1">frogs</requirement> - </requirements> - <stdio> - <exit_code range="1:" /> - <exit_code range=":-1" /> - </stdio> - <command> - upload_tar.py --param-file $paramfile - #set $outnum = 0 - #while $varExists('output%i' % $outnum): - #set $output = $getVar('output%i' % $outnum) - #set $outnum += 1 - --output ${output.dataset.dataset.id}:${output.file_name} - #end while - </command> - <inputs nginx_upload="true"> - <param name="async_datasets" type="hidden" value="None"/> - <param name="file_type" type="select" label="File Format" help="Which format? See help below"> - <options from_parameter="tool.app.datatypes_registry.upload_file_formats" transform_lines="[ "%s%s%s" % ( line, self.separator, line ) for line in obj ]"> - <column name="value" index="1"/> - <column name="name" index="0"/> - <filter type="sort_by" column="0"/> - <filter type="add_value" name="Auto-detect" value="auto" index="0"/> - </options> - </param> - <upload_dataset name="files" title="Specify Files for Dataset" file_type_name="file_type" metadata_ref="files_metadata"> - <param name="file_data" type="file" size="30" label="File" ajax-upload="true" help="TIP: Due to browser limitations, uploading files larger than 2GB is guaranteed to fail. To upload large files, use the URL method."> - <validator type="expression" message="You will need to reselect the file you specified (%s)." substitute_value_in_message="True">not ( ( isinstance( value, unicode ) or isinstance( value, str ) ) and value != "" )</validator> <!-- use validator to post message to user about needing to reselect the file, since most browsers won't accept the value attribute for file inputs --> - </param> - <param name="url_paste" type="text" size="35" label="URL" help="Here you may specify the archive URL."/> - <param name="ftp_files" type="ftpfile" label="Files uploaded via FTP"/> - <param name="uuid" type="hidden" required="False" /> - <param name="to_posix_lines" type="hidden" value="Yes" /> - </upload_dataset> - </inputs> - <outputs> - </outputs> - <help> + +<tool name="FROGS Upload archive" id="FROGS_upload_tar" version="1.1.0"> + <description> + from your computer + </description> + <action module="galaxy.tools.actions.upload" class="UploadToolAction"/> + <requirements> + <requirement type="package">samtools</requirement> + </requirements> + <command interpreter="python"> + upload.py $GALAXY_ROOT_DIR $GALAXY_DATATYPES_CONF_FILE $paramfile + #set $outnum = 0 + #while $varExists('output%i' % $outnum): + #set $output = $getVar('output%i' % $outnum) + #set $outnum += 1 + #set $file_name = $output.file_name + ## FIXME: This is not future-proof for other uses of external_filename (other than for use by the library upload's "link data" feature) + #if $output.dataset.dataset.external_filename: + #set $file_name = "None" + #end if + ${output.dataset.dataset.id}:${output.files_path}:${file_name} + #end while + </command> + <inputs nginx_upload="true"> + <param name="file_type" type="select" label="File Format" help="Which format? See help below"> + <options from_parameter="tool.app.datatypes_registry.upload_file_formats" transform_lines="[ "%s%s%s" % ( line, self.separator, line ) for line in obj ]"> + <column name="value" index="1"/> + <column name="name" index="0"/> + <filter type="sort_by" column="0"/> + <filter type="add_value" name="Auto-detect" value="auto" index="0"/> + </options> + </param> + <param name="async_datasets" type="hidden" value="None"/> + <upload_dataset name="files" title="Specify Files for Dataset" file_type_name="file_type" metadata_ref="files_metadata"> + <param name="file_data" type="file" size="30" label="File" ajax-upload="true" help="TIP: Due to browser limitations, uploading files larger than 2GB is guaranteed to fail. To upload large files, use the URL method (below) or FTP (if enabled by the site administrator)."> + <validator type="expression" message="You will need to reselect the file you specified (%s)." substitute_value_in_message="True">not ( ( isinstance( value, unicode ) or isinstance( value, str ) ) and value != "" )</validator> <!-- use validator to post message to user about needing to reselect the file, since most browsers won't accept the value attribute for file inputs --> + </param> + <param name="url_paste" type="text" area="true" size="5x35" label="URL/Text" help="Here you may specify a list of URLs (one per line) or paste the contents of a file."/> + <param name="ftp_files" type="ftpfile" label="Files uploaded via FTP"/> + <param name="space_to_tab" type="select" display="checkboxes" multiple="True" label="Convert spaces to tabs" help="Use this option if you are entering intervals by hand."> + <option value="Yes">Yes</option> + </param> + <param name="NAME" type="hidden" help="Name for dataset in upload"></param> + </upload_dataset> + <param name="dbkey" type="genomebuild" label="Genome" /> + <conditional name="files_metadata" title="Specify metadata" value_from="self:app.datatypes_registry.get_upload_metadata_params" value_ref="file_type" value_ref_in_group="False" /> + <!-- <param name="other_dbkey" type="text" label="Or user-defined Genome" /> --> + </inputs> + <help> + +**Auto-detect** + +The system will attempt to detect Axt, Fasta, Fastqsolexa, Gff, Gff3, Html, Lav, Maf, Tabular, Wiggle, Bed and Interval (Bed with headers) formats. If your file is not detected properly as one of the known formats, it most likely means that it has some format problems (e.g., different number of columns on different rows). You can still coerce the system to set your data to the format you think it should be. You can also upload compressed files, which will automatically be decompressed. + +----- + +**Ab1** + +A binary sequence file in 'ab1' format with a '.ab1' file extension. You must manually select this 'File Format' when uploading the file. + +----- + +**Axt** + +blastz pairwise alignment format. Each alignment block in an axt file contains three lines: a summary line and 2 sequence lines. Blocks are separated from one another by blank lines. The summary line contains chromosomal position and size information about the alignment. It consists of 9 required fields. + +----- + +**Bam** + +A binary file compressed in the BGZF format with a '.bam' file extension. + +----- + +**Bed** + +* Tab delimited format (tabular) +* Does not require header line +* Contains 3 required fields: + + - chrom - The name of the chromosome (e.g. chr3, chrY, chr2_random) or contig (e.g. ctgY1). + - chromStart - The starting position of the feature in the chromosome or contig. The first base in a chromosome is numbered 0. + - chromEnd - The ending position of the feature in the chromosome or contig. The chromEnd base is not included in the display of the feature. For example, the first 100 bases of a chromosome are defined as chromStart=0, chromEnd=100, and span the bases numbered 0-99. + +* May contain 9 additional optional BED fields: + + - name - Defines the name of the BED line. This label is displayed to the left of the BED line in the Genome Browser window when the track is open to full display mode or directly to the left of the item in pack mode. + - score - A score between 0 and 1000. If the track line useScore attribute is set to 1 for this annotation data set, the score value will determine the level of gray in which this feature is displayed (higher numbers = darker gray). + - strand - Defines the strand - either '+' or '-'. + - thickStart - The starting position at which the feature is drawn thickly (for example, the start codon in gene displays). + - thickEnd - The ending position at which the feature is drawn thickly (for example, the stop codon in gene displays). + - itemRgb - An RGB value of the form R,G,B (e.g. 255,0,0). If the track line itemRgb attribute is set to "On", this RBG value will determine the display color of the data contained in this BED line. NOTE: It is recommended that a simple color scheme (eight colors or less) be used with this attribute to avoid overwhelming the color resources of the Genome Browser and your Internet browser. + - blockCount - The number of blocks (exons) in the BED line. + - blockSizes - A comma-separated list of the block sizes. The number of items in this list should correspond to blockCount. + - blockStarts - A comma-separated list of block starts. All of the blockStart positions should be calculated relative to chromStart. The number of items in this list should correspond to blockCount. + +* Example:: + + chr22 1000 5000 cloneA 960 + 1000 5000 0 2 567,488, 0,3512 + chr22 2000 6000 cloneB 900 - 2000 6000 0 2 433,399, 0,3601 + +----- + +**Fasta** + +A sequence in FASTA format consists of a single-line description, followed by lines of sequence data. The first character of the description line is a greater-than (">") symbol in the first column. All lines should be shorter than 80 characters:: -.. class:: infomark page-header h2 + >sequence1 + atgcgtttgcgtgc + gtcggtttcgttgc + >sequence2 + tttcgtgcgtatag + tggcgcggtga + +----- + +**FastqSolexa** -What it does +FastqSolexa is the Illumina (Solexa) variant of the Fastq format, which stores sequences and quality scores in a single file:: -Allow to upload a TAR archive as one dataset in Galaxy. - + @seq1 + GACAGCTTGGTTTTTAGTGAGTTGTTCCTTTCTTT + +seq1 + hhhhhhhhhhhhhhhhhhhhhhhhhhPW@hhhhhh + @seq2 + GCAATGACGGCAGCAATAAACTCAACAGGTGCTGG + +seq2 + hhhhhhhhhhhhhhYhhahhhhWhAhFhSIJGChO + +Or:: -.. class:: infomark page-header h2 + @seq1 + GAATTGATCAGGACATAGGACAACTGTAGGCACCAT + +seq1 + 40 40 40 40 35 40 40 40 25 40 40 26 40 9 33 11 40 35 17 40 40 33 40 7 9 15 3 22 15 30 11 17 9 4 9 4 + @seq2 + GAGTTCTCGTCGCCTGTAGGCACCATCAATCGTATG + +seq2 + 40 15 40 17 6 36 40 40 40 25 40 9 35 33 40 14 14 18 15 17 19 28 31 4 24 18 27 14 15 18 2 8 12 8 11 9 + +----- -Advices +**Gff** + +GFF lines have nine required fields that must be tab-separated. -To generate a TAR archive on windows, you can use `7zip <http://www.7-zip.org/>`_ and choose as archive format *tar* +----- + +**Gff3** + +The GFF3 format addresses the most common extensions to GFF, while preserving backward compatibility with previous formats. -If your file is larger than 2GB, you need to upload your archive on a public server before indicating its public URL +----- + +**Interval (Genomic Intervals)** -If you have access to a tool generating symbolic link on your Galaxy account, prefer this latest option in any cases. +- Tab delimited format (tabular) +- File must start with definition line in the following format (columns may be in any order).:: + + #CHROM START END STRAND ----- +- CHROM - The name of the chromosome (e.g. chr3, chrY, chr2_random) or contig (e.g. ctgY1). +- START - The starting position of the feature in the chromosome or contig. The first base in a chromosome is numbered 0. +- END - The ending position of the feature in the chromosome or contig. The chromEnd base is not included in the display of the feature. For example, the first 100 bases of a chromosome are defined as chromStart=0, chromEnd=100, and span the bases numbered 0-99. +- STRAND - Defines the strand - either '+' or '-'. -**Contact** +- Example:: + + #CHROM START END STRAND NAME COMMENT + chr1 10 100 + exon myExon + chrX 1000 10050 - gene myGene + +----- -Contacts: frogs@inra.fr +**Lav** + +Lav is the primary output format for BLASTZ. The first line of a .lav file begins with #:lav.. + +----- -Repository: https://github.com/geraldinepascal/FROGS +**MAF** + +TBA and multiz multiple alignment format. The first line of a .maf file begins with ##maf. This word is followed by white-space-separated "variable=value" pairs. There should be no white space surrounding the "=". + +----- + +**Scf** -Please cite the FROGS Publication: *Escudie F., Auer L., Bernard M., Cauquil L., Vidal K., Maman S., Mariadassou M., Hernadez-Raquet G., Pascal G., 2015. FROGS: Find Rapidly OTU with Galaxy Solution. In: The environmental genomic Conference, Montpellier, France,* http://bioinfo.genotoul.fr/fileadmin/user_upload/FROGS_2015_GE_Montpellier_poster.pdf +A binary sequence file in 'scf' format with a '.scf' file extension. You must manually select this 'File Format' when uploading the file. + +----- + +**Sff** + +A binary file in 'Standard Flowgram Format' with a '.sff' file extension. + +----- + +**Tabular (tab delimited)** + +Any data in tab delimited format (tabular) -Depending on the help provided you can cite us in acknowledgements, references or both. - </help> - <citations> - <citation type="doi">10.7287/peerj.preprints.386v1</citation> - </citations> +----- + +**Wig** + +The wiggle format is line-oriented. Wiggle data is preceded by a track definition line, which adds a number of options for controlling the default display of this track. + +----- + +**Other text type** + +Any text file + + </help> </tool>