nf-core_modules/modules/entrezdirect/esummary/meta.yml
Alexander Ramos Díaz b4452a4881
Add ENTREZDIRECT/ESUMMARY (#1833)
* first commit

* entrezdirect/esummary fixed version definition

* resolved suggestion

* updated main.nf

* changed output definition

* output: XML file

* output definition:  XML file

* updated XML format in tests

* updated test file

* version: esummary instead of entrezdirect

* output file pattern: *.esummary.xml

* updated test file

* updated versions

* restored versions stdout

* updated test file

* changed xml_esummary pattern

* changed entrezdirect to  esummary version

* updated test file

* Update modules/entrezdirect/esummary/meta.yml

changed output file pattern: "*.xml"

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/meta.yml

updated keywords

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/main.nf

Output file pattern: *.xml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/main.nf

Output file pattern: *.xml

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/main.nf

database as separate input channel

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* removed blank spaces in input definition

* database as separate channel

* conditional script for stdin

* updated input definition

* entrez-direct version:16.2_1

* all input channels are separate

* ignore stderr, catch xml stdout

* removed blank lines

* added ids file input

* updated test

* conditional script for input

* removed bad definition of input file

* updated test file

* Update modules/entrezdirect/esummary/main.nf

changed input definition: ui, uids_file

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/meta.yml

added uids_file description

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* Update modules/entrezdirect/esummary/main.nf

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* input: uid or uids_file

* updated input

* added uids_file to input

* input file as optional input

* input file as optional input in each test

* new conditional script

* unpdated test file

* single input definition

* added error messages

* updated test

* removed cat from command output

* Update modules/entrezdirect/esummary/main.nf

added comment on use of grep in output

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>

* added comment

* removed blank spaces

* input file: empty list

* input file: empty list

* removed comment at wrong position

* optional file defined as empty list

* updated successful test

* Apply suggestions from code review

Accepted suggestions.

Co-authored-by: Matthieu Muffato <mm49@sanger.ac.uk>

* Update modules/entrezdirect/esummary/main.nf

Fixed comment.

Co-authored-by: Matthieu Muffato <mm49@sanger.ac.uk>

* Update modules/entrezdirect/esummary/main.nf

Updated grep in output file.

Co-authored-by: Matthieu Muffato <mm49@sanger.ac.uk>

* added tail -n+3 before output

* updated successful test

Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: Matthieu Muffato <mm49@sanger.ac.uk>
2022-07-13 11:26:58 -06:00

57 lines
1.8 KiB
YAML

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_esummary:
type: file
description: Query result in XML format
pattern: "*.xml"
authors:
- "@alxndrdiaz"