name: "entrezdirect_esummary"
description: Queries an NCBI database using Unique Identifier(s)
keywords:
  - public datasets
  - ncbi
  - entrez
  - metadata
  - query
  - database
tools:
  - entrezdirect:
      description: |
        Entrez Direct (EDirect) is a method for accessing the NCBI's set of
        interconnected databases (publication, sequence, structure, gene,
        variation, expression, etc.) from a UNIX terminal window. Functions
        take search terms from command line arguments. Individual operations
        are combined to build multi-step queries. Record retrieval and
        formatting normally complete the process.
      homepage: https://www.ncbi.nlm.nih.gov/books/NBK179288/
      documentation: https://www.ncbi.nlm.nih.gov/books/NBK25501/
      tool_dev_url: https://www.ncbi.nlm.nih.gov/books/NBK25498/
      doi: 10.1016/S0076-6879(96)66012-1
      licence: ["PUBLIC DOMAIN"]

input:
  - meta:
      type: map
      description: |
        Groovy Map containing sample information
        e.g. [ id:'test', single_end:false ]
  - database:
      type: value
      description: Value must be a valid Entrez database name ('assembly', etc).
  - uid:
      type: value
      description: Unique Identifier (UID) of record in NCBI database. Cannot be used at the same time as uids_file
  - uids_file:
      type: file
      description: Text file containing multiple UIDs. Cannot be used at the same time as uid.

output:
  - meta:
      type: map
      description: |
        Groovy Map containing sample information
        e.g. [ id:'test', single_end:false ]
  - versions:
      type: file
      description: File containing software versions
      pattern: "versions.yml"
  - xml:
      type: file
      description: Query result in XML format
      pattern: "*.xml"

authors:
  - "@alxndrdiaz"