view macros.xml @ 16:a6a475ed58cb draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/ncbi_datasets commit 9a34ebfc4d6b987b71e545dcf5dbdd884cd8d88e
author iuc
date Fri, 07 Jun 2024 14:19:58 +0000
parents 198c75abbf55
children
line wrap: on
line source

<macros>
    <token name="@TOOL_VERSION@">16.20.0</token>
    <token name="@VERSION_SUFFIX@">0</token>
    <token name="@PROFILE@">23.0</token>
    <token name="@LICENSE@">MIT</token>
    <token name="@PROFILE_AND_LICENSE@">profile="@PROFILE@" license="@LICENSE@"</token>
    <token name="@SETUP_CERTIFICATES@"><![CDATA[
## If running in a container use certificates from ca-certificates instead of outdated/missing container certificates
[ -f /usr/local/ssl/cacert.pem ] && export SSL_CERT_FILE="/usr/local/ssl/cacert.pem";
        ]]></token>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="@TOOL_VERSION@">ncbi-datasets-cli</requirement>
            <requirement type="package" version="2024.2.2">ca-certificates</requirement>
            <requirement type="package" version="16.02">p7zip</requirement>
        </requirements>
    </xml>
    <xml name="bio_tools">
        <xrefs>
            <xref type="bio.tools">ncbi_datasets</xref>
        </xrefs>
    </xml>
    <xml name="version_command"><![CDATA[
        datasets --version | cut -d" " -f 3
    ]]></xml>
    <xml name="annotation">
        <param argument="--annotated" type="boolean" truevalue="--annotated" falsevalue="" label="Only include genomes with annotation ?"/>
    </xml>
    <xml name="assembly_level">
        <param argument="--assembly-level" type="select" label="Restrict assemblies to a comma-separated list of one or more of these" multiple="true" optional="true">
            <option value="chromosome">Chromosome</option>
            <option value="complete">Complete Genome</option>
            <option value="contig">Contig</option>
            <option value="scaffold">Scaffold</option>
        </param>
    </xml>
    <xml name="assembly_source">
        <param argument="--assembly-source" type="select" optional="true" label="Assembly source" help="Default (nothing selected) is both " >
            <option value="refseq">RefSeq</option>
            <option value="genbank">GenBank</option>
        </param>
    </xml>
    <xml name="text_or_file" token_what="accession" token_what_extended="NCBI Assembly accession" token_help="Can be NCBI Assembly or BioProject accession">
        <conditional name="text_or_file" label="How do you want to specify the @WHAT@(s) to download">
            <param name="text_or_file" type="select" label="Enter @WHAT@ or read from file ?">
                <option value="text">Enter @WHAT@s</option>
                <option value="file">Read a list of @WHAT_EXTENDED@s from a dataset</option>
            </param>
            <when value="text">
                <!-- command section also allows spaces as separator for backward compatibility
                     prefer comma because this is used also in other text params-->
                <param name="accession" type="text" label="Enter comma separated list of @WHAT@s" help="@HELP@">
                    <validator type="length" min="1" message="Provide at least one @WHAT@"/>
                </param>
            </when>
            <when value="file">
                <param argument="--inputfile" type="data" format="txt" label="Select dataset with list of @WHAT_EXTENDED@s" help="@HELP@"/>
            </when>
        </conditional>
    </xml>
    <xml name="chromosomes">
        <param argument="--chromosomes" type="text" label="Limit chromosomes to a comma-delimited list of chromosomes">
            <sanitizer invalid_char="">
                <valid initial="string.letters,string.digits">
                    <add value="_" />
                    <add value="." />
                    <add value="," />
                </valid>
            </sanitizer>
        </param>
    </xml>

    <xml name="taxon_positional">
        <param name="taxon_positional" type="text" label="Enter taxon" help="e.g. human, house mouse, bos taurus, etc. or use Taxonomy ID from NCBI for greater accuracy, use species-level only not genera or larger taxa"/>
    </xml>

    <xml name="ortholog">
        <param argument="--ortholog" type="text" label="Retrieve orthologs for taxa" help="Retrieve data for an ortholog set. Provide one or more comma separated taxa (any rank) to filter results or 'all' for the complete set.">
            <sanitizer invalid_char="">
                <valid initial="string.letters,string.digits">
                    <add value=" " />
                    <add value="," />
                    <add value="-" />
                </valid>
            </sanitizer>
        </param>
    </xml>

    <xml name="include">
        <param argument="--include" type="select" multiple="true" optional="true" label="Include" help="Download the following datasets (if available)">
            <yield/>
        </param>
    </xml>
    <xml name="genome_includes">
        <option value="genome" selected="true">genomic sequence (genome)</option>
        <option value="rna">transcript (rna)</option>
        <option value="protein">amnio acid sequences (protein)</option>
        <option value="cds">nucleotide coding sequences (cds)</option>
        <option value="gff3">general feature file (gff3)</option>
        <option value="gtf">gene transfer format (gtf)</option>
        <option value="gbff">GenBank flat file (gbff)</option>
        <option value="seq-report">sequence report file (seq-report)</option>
        <yield/>
    </xml>
    <xml name="gene_includes">
        <option value="gene">gene sequence (gene)</option>
        <option value="protein" selected="true">amnio acid sequences (protein)</option>
        <yield/>
    </xml>

    <token name="@INCLUDE@"><![CDATA[
        --include
        #if $file_choices.include
            #echo ",".join($file_choices.include)
        #else
            none
        #end if
    ]]></token>
    <xml name="tsv_report_columns">
        <param name="report_columns" type="select" multiple="true" optional="false" label="Columns in the report">
            <option value="accession">Assembly Accession</option>
            <option value="annotinfo-busco-complete">Annotation BUSCO Complete</option>
            <option value="annotinfo-busco-duplicated">Annotation BUSCO Duplicated</option>
            <option value="annotinfo-busco-fragmented">Annotation BUSCO Fragmented</option>
            <option value="annotinfo-busco-lineage">Annotation BUSCO Lineage</option>
            <option value="annotinfo-busco-missing">Annotation BUSCO Missing</option>
            <option value="annotinfo-busco-singlecopy">Annotation BUSCO Single Copy</option>
            <option value="annotinfo-busco-totalcount">Annotation BUSCO Total Count</option>
            <option value="annotinfo-busco-ver">Annotation BUSCO Version</option>
            <option value="annotinfo-featcount-gene-non-coding">Annotation Count Gene Non-coding</option>
            <option value="annotinfo-featcount-gene-other">Annotation Count Gene Other</option>
            <option value="annotinfo-featcount-gene-protein-coding">Annotation Count Gene Protein-coding</option>
            <option value="annotinfo-featcount-gene-pseudogene">Annotation Count Gene Pseudogene</option>
            <option value="annotinfo-featcount-gene-total">Annotation Count Gene Total</option>
            <option value="annotinfo-method">Annotation Method</option>
            <option value="annotinfo-name">Annotation Name</option>
            <option value="annotinfo-pipeline">Annotation Pipeline</option>
            <option value="annotinfo-provider">Annotation Provider</option>
            <option value="annotinfo-release-date">Annotation Release Date</option>
            <option value="annotinfo-release-version">Annotation Release Version</option>
            <option value="annotinfo-report-url">Annotation Report URL</option>
            <option value="annotinfo-software-version">Annotation Software Version</option>
            <option value="annotinfo-status">Annotation Status</option>
            <option value="assminfo-atypicalis-atypical">Assembly Atypical Is Atypical</option>
            <option value="assminfo-atypicalwarnings">Assembly Atypical Warnings</option>
            <option value="assminfo-bioproject-lineage-accession">Assembly BioProject Lineage Accession</option>
            <option value="assminfo-bioproject-lineage-parent-accession">Assembly BioProject Lineage Parent Accession</option>
            <option value="assminfo-bioproject-lineage-parent-accessions">Assembly BioProject Lineage Parent Accessions</option>
            <option value="assminfo-bioproject-lineage-title">Assembly BioProject Lineage Title</option>
            <option value="assminfo-biosample-accession">Assembly BioSample Accession</option>
            <option value="assminfo-biosample-attribute-name">Assembly BioSample Attribute Name</option>
            <option value="assminfo-biosample-attribute-value">Assembly BioSample Attribute Value</option>
            <option value="assminfo-biosample-bioproject-accession">Assembly BioSample BioProject Accession</option>
            <option value="assminfo-biosample-bioproject-parent-accession">Assembly BioSample BioProject Parent Accession</option>
            <option value="assminfo-biosample-bioproject-parent-accessions">Assembly BioSample BioProject Parent Accessions</option>
            <option value="assminfo-biosample-bioproject-title">Assembly BioSample BioProject Title</option>
            <option value="assminfo-biosample-description-comment">Assembly BioSample Description Comment</option>
            <option value="assminfo-biosample-description-organism-common-name">Assembly BioSample Description Organism Common Name</option>
            <option value="assminfo-biosample-description-organism-infraspecific-breed">Assembly BioSample Description Organism Infraspecific Names Breed</option>
            <option value="assminfo-biosample-description-organism-infraspecific-cultivar">Assembly BioSample Description Organism Infraspecific Names Cultivar</option>
            <option value="assminfo-biosample-description-organism-infraspecific-ecotype">Assembly BioSample Description Organism Infraspecific Names Ecotype</option>
            <option value="assminfo-biosample-description-organism-infraspecific-isolate">Assembly BioSample Description Organism Infraspecific Names Isolate</option>
            <option value="assminfo-biosample-description-organism-infraspecific-sex">Assembly BioSample Description Organism Infraspecific Names Sex</option>
            <option value="assminfo-biosample-description-organism-infraspecific-strain">Assembly BioSample Description Organism Infraspecific Names Strain</option>
            <option value="assminfo-biosample-description-organism-name">Assembly BioSample Description Organism Name</option>
            <option value="assminfo-biosample-description-organism-pangolin">Assembly BioSample Description Organism Pangolin Classification</option>
            <option value="assminfo-biosample-description-organism-tax-id">Assembly BioSample Description Organism Taxonomic ID</option>
            <option value="assminfo-biosample-description-title">Assembly BioSample Description Title</option>
            <option value="assminfo-biosample-ids-db">Assembly BioSample Sample Identifiers Database</option>
            <option value="assminfo-biosample-ids-label">Assembly BioSample Sample Identifiers Label</option>
            <option value="assminfo-biosample-ids-value">Assembly BioSample Sample Identifiers Value</option>
            <option value="assminfo-biosample-last-updated">Assembly BioSample Last updated</option>
            <option value="assminfo-biosample-models">Assembly BioSample Models</option>
            <option value="assminfo-biosample-owner-contact-lab">Assembly BioSample Owner Contact Lab</option>
            <option value="assminfo-biosample-owner-name">Assembly BioSample Owner Name</option>
            <option value="assminfo-biosample-package">Assembly BioSample Package</option>
            <option value="assminfo-biosample-publication-date">Assembly BioSample Publication date</option>
            <option value="assminfo-biosample-status-status">Assembly BioSample Status Status</option>
            <option value="assminfo-biosample-status-when">Assembly BioSample Status When</option>
            <option value="assminfo-biosample-submission-date">Assembly BioSample Submission date</option>
            <option value="assminfo-blast-url">Assembly Blast URL</option>
            <option value="assminfo-description">Assembly Description</option>
            <option value="assminfo-level">Assembly Level</option>
            <option value="assminfo-linked-assmaccession">Assembly Linked Assembly Accession</option>
            <option value="assminfo-linked-assmtype">Assembly Linked Assembly Type</option>
            <option value="assminfo-name">Assembly Name</option>
            <option value="assminfo-paired-assmaccession">Assembly Paired Assembly Accession</option>
            <option value="assminfo-paired-assmname">Assembly Paired Assembly Name</option>
            <option value="assminfo-paired-assmstatus">Assembly Paired Assembly Status</option>
            <option value="assminfo-refseq-category">Assembly Refseq Category</option>
            <option value="assminfo-sequencing-tech">Assembly Sequencing Tech</option>
            <option value="assminfo-status">Assembly Status</option>
            <option value="assminfo-submission-date">Assembly Submission Date</option>
            <option value="assminfo-submitter">Assembly Submitter</option>
            <option value="assminfo-synonym">Assembly Synonym</option>
            <option value="assminfo-type">Assembly Type</option>
            <option value="assmstats-contig-l50">Assembly Stats Contig L50</option>
            <option value="assmstats-contig-n50">Assembly Stats Contig N50</option>
            <option value="assmstats-gaps-between-scaffolds-count">Assembly Stats Gaps Between Scaffolds Count</option>
            <option value="assmstats-gc-count">Assembly Stats GC Count</option>
            <option value="assmstats-gc-percent">Assembly Stats GC Percent</option>
            <option value="assmstats-number-of-component-sequences">Assembly Stats Number of Component Sequences</option>
            <option value="assmstats-number-of-contigs">Assembly Stats Number of Contigs</option>
            <option value="assmstats-number-of-scaffolds">Assembly Stats Number of Scaffolds</option>
            <option value="assmstats-scaffold-l50">Assembly Stats Scaffold L50</option>
            <option value="assmstats-scaffold-n50">Assembly Stats Scaffold N50</option>
            <option value="assmstats-total-number-of-chromosomes">Assembly Stats Total Number of Chromosomes</option>
            <option value="assmstats-total-sequence-len">Assembly Stats Total Sequence Length</option>
            <option value="assmstats-total-ungapped-len">Assembly Stats Total Ungapped Length</option>
            <option value="current-accession">Current Accession</option>
            <option value="organelle-assembly-name">Organelle Assembly Name</option>
            <option value="organelle-bioproject-accessions">Organelle BioProject Accessions</option>
            <option value="organelle-description">Organelle Description</option>
            <option value="organelle-infraspecific-name">Organelle Infraspecific Name</option>
            <option value="organelle-submitter">Organelle Submitter</option>
            <option value="organelle-total-seq-length">Organelle Total Seq Length</option>
            <option value="organism-common-name">Organism Common Name</option>
            <option value="organism-infraspecific-breed">Organism Infraspecific Names Breed</option>
            <option value="organism-infraspecific-cultivar">Organism Infraspecific Names Cultivar</option>
            <option value="organism-infraspecific-ecotype">Organism Infraspecific Names Ecotype</option>
            <option value="organism-infraspecific-isolate">Organism Infraspecific Names Isolate</option>
            <option value="organism-infraspecific-sex">Organism Infraspecific Names Sex</option>
            <option value="organism-infraspecific-strain">Organism Infraspecific Names Strain</option>
            <option value="organism-name">Organism Name</option>
            <option value="organism-pangolin">Organism Pangolin Classification</option>
            <option value="organism-tax-id">Organism Taxonomic ID</option>
            <option value="source_database">Source Database</option>
            <option value="wgs-contigs-url">WGS contigs URL</option>
            <option value="wgs-project-accession">WGS project accession</option>
            <option value="wgs-url">WGS URL</option>
            <yield/>
        </param>
    </xml>

    <xml name="gene_tsv_report_columns">
        <param name="report_columns" type="select" multiple="true" optional="false" label="Columns in the report">
            <option value="annotation-assembly-accession">Annotation Assembly Accession</option>
            <option value="annotation-assembly-name">Annotation Assembly Name</option>
            <option value="annotation-genomic-range-accession">Annotation Genomic Range Accession</option>
            <option value="annotation-genomic-range-exon-order">Annotation Genomic Range Exons Order</option>
            <option value="annotation-genomic-range-exon-orientation">Annotation Genomic Range Exons Orientation</option>
            <option value="annotation-genomic-range-exon-start">Annotation Genomic Range Exons Start</option>
            <option value="annotation-genomic-range-exon-stop">Annotation Genomic Range Exons Stop</option>
            <option value="annotation-genomic-range-range-order">Annotation Genomic Range Order</option>
            <option value="annotation-genomic-range-range-orientation">Annotation Genomic Range Orientation</option>
            <option value="annotation-genomic-range-range-start">Annotation Genomic Range Start</option>
            <option value="annotation-genomic-range-range-stop">Annotation Genomic Range Stop</option>
            <option value="annotation-genomic-range-seq-name">Annotation Genomic Range Seq Name</option>
            <option value="annotation-release-date">Annotation Release Date</option>
            <option value="annotation-release-name">Annotation Release Name</option>
            <option value="chromosomes">Chromosomes</option>
            <option value="common-name">Common Name</option>
            <option value="description">Description</option>
            <option value="ensembl-geneids">Ensembl GeneIDs</option>
            <option value="gene-id">NCBI GeneID</option>
            <option value="gene-type">Gene Type</option>
            <option value="genomic-region-gene-range-accession">Genomic Region Gene Range Sequence Accession</option>
            <option value="genomic-region-gene-range-range-order">Genomic Region Gene Range Order</option>
            <option value="genomic-region-gene-range-range-orientation">Genomic Region Gene Range Orientation</option>
            <option value="genomic-region-gene-range-range-start">Genomic Region Gene Range Start</option>
            <option value="genomic-region-gene-range-range-stop">Genomic Region Gene Range Stop</option>
            <option value="genomic-region-genomic-region-type">Genomic Region Genomic Region Type</option>
            <option value="group-id">Gene Group Identifier</option>
            <option value="group-method">Gene Group Method</option>
            <option value="name-authority">Nomenclature Authority</option>
            <option value="name-id">Nomenclature ID</option>
            <option value="omim-ids">OMIM IDs</option>
            <option value="orientation">Orientation</option>
            <option value="ref-standard-gene-range-accession">Reference Standard Gene Range Sequence Accession</option>
            <option value="ref-standard-gene-range-range-order">Reference Standard Gene Range Order</option>
            <option value="ref-standard-gene-range-range-orientation">Reference Standard Gene Range Orientation</option>
            <option value="ref-standard-gene-range-range-start">Reference Standard Gene Range Start</option>
            <option value="ref-standard-gene-range-range-stop">Reference Standard Gene Range Stop</option>
            <option value="ref-standard-genomic-region-type">Reference Standard Genomic Region Type</option>
            <option value="replaced-gene-id">Replaced NCBI GeneID</option>
            <option value="rna-type">RNA Type</option>
            <option value="swissprot-accessions">SwissProt Accessions</option>
            <option value="symbol">Symbol</option>
            <option value="synonyms">Synonyms</option>
            <option value="tax-id">Taxonomic ID</option>
            <option value="tax-name">Taxonomic Name</option>
            <yield/>
        </param>
    </xml>
    <xml name="prok_gene_tsv_report_columns">
        <param name="report_columns" type="select" multiple="true" optional="false" label="Columns in the report">
            <option value="accession">Accession</option>
            <option value="description">Description</option>
            <option value="ec-number">EC Number</option>
            <option value="gene-symbol">Gene Symbol</option>
            <option value="mapping-count">Number of Genome Mappings</option>
            <option value="name-evidence-accession">Protein Name EvidenceAccession</option>
            <option value="name-evidence-category">Protein Name EvidenceCategory</option>
            <option value="name-evidence-source">Protein Name EvidenceSource</option>
            <option value="protein-length">Protein Length</option>
            <option value="protein-name">Protein Name</option>
            <yield/>
        </param>
    </xml>
    <xml name="released_options" token_released_what="genomes" token_before_or_after="before">
        <param argument="--released-@BEFORE_OR_AFTER@" type="text" optional="true" label="Only include @RELEASED_WHAT@ that have been released @BEFORE_OR_AFTER@ a specified date (MM/DD/YYYY)">
            <validator type="regex" message="enter a date in the form MM/DD/YYYY">[0-9]{2}/[0-9]{2}/[0-9]{4}</validator>
        </param>
    </xml>
    <token name="@RELEASED_BEFORE@">#if $filters.released_before:
--released-before '$filters.released_before'
#end if
    </token>
    <token name="@RELEASED_AFTER@">#if $filters.released_after:
--released-after '$filters.released_after'
#end if
    </token>
    <xml name="genome_fasta_assert" tokens="el1,el2,expression" token_ftype="fasta" token_expression_n="1">
        <element name="@EL1@">
            <element name="@EL2@" ftype="@FTYPE@" decompress="true">
                <assert_contents>
                    <has_text_matching expression="@EXPRESSION@" n="@EXPRESSION_N@"/>
                </assert_contents>
            </element>
        </element>
    </xml>
    <xml name="citations">
        <citations>
            <citation type="bibtex">@misc{NCBI,
                author = "{NCBI}",
                title = "NCBI Datasets",
                year = "2022",
                url = "https://github.com/ncbi/datasets"}
            </citation>
        </citations>
    </xml>
</macros>