问题
如何使人们更容易引用我的工具描述?
目标
了解如何向CWL描述添加作者信息和其他元数据。
正确执行不需要实现扩展(例如,与GUI表示相关的字段)和关于工具或工作流本身的元数据(例如,在引用中使用的作者身份)可以作为任何对象的附加字段提供。这些扩展字段(例如format: edam:format2572)可以使用文档的$namespacessection中列出的名称空间前缀(例如edam: http://edamontology.org/),正如模式规范中描述的那样。添加名称空间前缀后,就可以在文档中的任何地方访问它,如下所示。否则必须使用完整url:格式:http://edamontology.org/format_2572。
对于所有开发人员,我们为您的工具和工作流推荐以下最小元数据。这个示例包含了允许其他人引用您的工具的元数据。
_metadata_example2.cwl
#!/usr/bin/env cwl-runner
cwlVersion: v1.0
class: CommandLineTool
label: An example tool demonstrating metadata.
doc: Note that this is an example and the metadata is not necessarily consistent.
inputs:
aligned_sequences:
type: File
label: Aligned sequences in BAM format
format: edam:format_2572
inputBinding:
position: 1
baseCommand: [ wc, -l ]
stdout: output.txt
outputs:
report:
type: stdout
format: edam:format_1964
label: A text file that contains a line count
s:author:
- class: s:Person
s:identifier: https://orcid.org/0000-0002-6130-1021
s:email: mailto:dyuen@oicr.on.ca
s:name: Denis Yuen
s:contributor:
- class: s:Person
s:identifier: http://orcid.org/0000-0002-7681-6415
s:email: mailto:briandoconnor@gmail.com
s:name: Brian O'Connor
s:citation: https://dx.doi.org/10.6084/m9.figshare.3115156.v2
s:codeRepository: https://github.com/common-workflow-language/common-workflow-language
s:dateCreated: "2016-12-13"
s:license: https://spdx.org/licenses/Apache-2.0
$namespaces:
s: https://schema.org/
edam: http://edamontology.org/
$schemas:
- http://schema.org/version/9.0/schemaorg-current-http.rdf
- http://edamontology.org/EDAM_1.18.owl
命令行格式的CWL描述等价如下:
wc -l /path/to/aligned_sequences.ext > output.txt