1. 问题
    2. 我如何创建并导入我自己的自定义类型到CWL描述中?
    3. 目标
    4. 学习如何编写自定义CWL对象类型。
    5. 学习如何将这些自定义对象导入工具描述。

    有时，您可能希望编写自己的自定义类型，以便在CWL描述中使用和重用。使用这种自定义类型可以减少多个使用相同类型的描述之间的冗余，并且允许额外的自定义/配置工具/分析，而不需要直接处理CWL描述。
    下面的示例是biom convert format工具的CWL描述，用于将标准的biom表文件转换为hd5格式。
    custom-types.cwl

    1. #!/usr/bin/env cwl-runner 
    2. cwlVersion: v1.0
    3. class: CommandLineTool
    5. requirements:
    6.   InlineJavascriptRequirement: {}
    7.   ResourceRequirement:
    8.     coresMax: 1
    9.     ramMin: 100  # just a default, could be lowered
    10.   SchemaDefRequirement:
    11.     types:
    12.       - $import: biom-convert-table.yaml
    14. hints:
    15.   DockerRequirement:
    16.     dockerPull: 'quay.io/biocontainers/biom-format:2.1.6--py27_0'
    17.   SoftwareRequirement:
    18.     packages:
    19.       biom-format:
    20.         specs: [ "https://doi.org/10.1186/2047-217X-1-7" ]
    21.         version: [ "2.1.6" ]
    23. inputs:
    24.   biom:
    25.     type: File
    26.     format: edam:format_3746  # BIOM
    27.     inputBinding:
    28.       prefix: --input-fp
    29.   table_type:
    30.     type: biom-convert-table.yaml#table_type
    31.     inputBinding:
    32.       prefix: --table-type
    34.   header_key:
    35.     type: string?
    36.     doc: |
    37.       The observation metadata to include from the input BIOM table file when
    38.       creating a tsv table file. By default no observation metadata will be
    39.       included.
    40.     inputBinding:
    41.       prefix: --header-key
    43. baseCommand: [ biom, convert ]
    45. arguments:
    46.   - valueFrom: $(inputs.biom.nameroot).hdf5  
    47.     prefix: --output-fp
    48.   - --to-hdf5
    50. outputs:
    51.   result:
    52.     type: File
    53.     outputBinding: { glob: "$(inputs.biom.nameroot)*" }
    55. $namespaces:
    56.   edam: http://edamontology.org/
    57.   s: https://schema.org/
    59. $schemas:
    60.   - http://edamontology.org/EDAM_1.16.owl
    61.   - http://schema.org/version/9.0/schemaorg-current-http.rdf
    63. s:license: https://spdx.org/licenses/Apache-2.0
    64. s:copyrightHolder: "EMBL - European Bioinformatics Institute"

    custom-types.yml

    1. biom:
    2.     class: File
    3.     format: http://edamontology.org/format_3746
    4.     path: rich_sparse_otu_table.biom
    5. table_type: OTU table

    注意:要遵循下面的示例，您需要下载示例输入文件rich_sparse_otu_table.biom。该文件可从https://raw.githubusercontent.com/common-workflow-language/user_guide/gh-pages/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom获得，并可以通过wget下载:

    1. wget https://raw.githubusercontent.com/common-workflow-language/user_guide/gh-pages/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom

    在第34行，在inputs:table_type中，表转换中允许使用的表选项列表被作为自定义对象导入:

    1. inputs:
    2.   biom:
    3.     type: File
    4.     format: edam:format_3746  # BIOM
    5.     inputBinding:
    6.       prefix: --input-fp
    7.   table_type:
    8.     type: biom-convert-table.yaml#table_type
    9.     inputBinding:
    10.       prefix: --table-type

    对自定义类型的引用是定义对象的文件名(bio -convert-table.yaml)和定义自定义类型的文件中的对象名(table_type)的组合。在这种情况下，符号数组从导入的生物转换表。yaml文件定义允许的表选项。例如，在custom-types.yml中，我们传递OTU表作为输入，它告诉工具创建一个hd5格式的OTU表。
    描述自定义类型的YAML文件的内容如下所示:

    1. type: enum
    2. name: table_type
    3. label: The type of the table to produce
    4. symbols:
    5.   - OTU table
    6.   - Pathway table
    7.   - Function table
    8.   - Ortholog table
    9.   - Gene table
    10.   - Metabolite table
    11.   - Taxon table
    12.   - Table

    为了在CWL描述中使用自定义类型，必须导入它。导入在requirements: schemadefrerequirements中进行了描述，如下面的示例自定义类型中所示。cwl描述:

    1. requirements:
    2.   InlineJavascriptRequirement: {}
    3.   ResourceRequirement:
    4.     coresMax: 1
    5.     ramMin: 100
    6.   SchemaDefRequirement:
    7.     types:
    8.       - $import: biom-convert-table.yaml

    还要注意这CWL描述的作者也包括ResourceRequirements,指定内存的最小数量和所需数量的核心工具运行成功,以及详细的版本的软件,和其他有用的描述写元数据。这些特性将在本用户指南的其他章节中进一步讨论。