modules-fork/modules/yaml-schema.json at master · mskcc-omics-workflows/modules-fork · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
{
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "Meta yaml",
    "description": "Validate the meta yaml file for an nf-core module",
    "type": "object",
    "properties": {
        "name": {
            "type": "string",
            "description": "Name of the module"
        },
        "description": {
            "type": "string",
            "description": "Description of the module"
        },
        "keywords": {
            "type": "array",
            "description": "Keywords for the module",
            "items": {
                "type": "string"
            },
            "minItems": 3
        },
        "authors": {
            "type": "array",
            "description": "Authors of the module",
            "items": {
                "type": "string"
            }
        },
        "input": {
            "type": "array",
            "description": "Input channels for the module",

            "items": {
                "type": "object",
                "patternProperties": {
                    ".*": {
                        "type": "object",
                        "properties": {
                            "type": {
                                "type": "string",
                                "description": "Type of the input channel",
                                "enum": ["map", "file", "directory", "string", "integer", "float", "boolean", "list"]
                            },
                            "description": {
                                "type": "string",
                                "description": "Description of the input channel"
                            },
                            "pattern": {
                                "type": "string",
                                "description": "Pattern of the input channel, given in Java glob syntax"
                            },
                            "default": {
                                "type": ["string", "number", "boolean", "array", "object"],
                                "description": "Default value for the input channel"
                            },
                            "enum": {
                                "type": "array",
                                "description": "List of allowed values for the input channel",
                                "items": {
                                    "type": ["string", "number", "boolean", "array", "object"]
                                },
                                "uniqueItems": true
                            }
                        },
                        "required": ["type", "description"]
                    }
                }
            }
        },

        "output": {
            "type": "array",
            "description": "Output channels for the module",
            "items": {
                "type": "object",
                "patternProperties": {
                    ".*": {
                        "type": "object",
                        "properties": {
                            "type": {
                                "type": "string",
                                "description": "Type of the output channel",
                                "enum": ["map", "file", "directory", "string", "integer", "float", "boolean", "list"]
                            },
                            "description": {
                                "type": "string",
                                "description": "Description of the output channel"
                            },
                            "pattern": {
                                "type": "string",
                                "description": "Pattern of the input channel, given in Java glob syntax"
                            },
                            "enum": {
                                "type": "array",
                                "description": "List of allowed values for the output channel",
                                "items": {
                                    "type": ["string", "number", "boolean", "array", "object"]
                                },
                                "uniqueItems": true
                            }
                        },
                        "required": ["type", "description"]
                    }
                }
            }
        },
        "tools": {
            "type": "array",
            "description": "Tools used by the module",
            "items": {
                "type": "object",
                "patternProperties": {
                    ".*": {
                        "type": "object",
                        "properties": {
                            "description": {
                                "type": "string",
                                "description": "Description of the output channel"
                            },
                            "homepage": {
                                "type": "string",
                                "description": "Homepage of the tool",
                                "pattern": "^(http|https)://.*$"
                            },
                            "documentation": {
                                "type": "string",
                                "description": "Documentation of the tool",
                                "pattern": "^(http|https|ftp)://.*$"
                            },
                            "tool_dev_url": {
                                "type": "string",
                                "description": "URL of the development version of the tool's documentation",
                                "pattern": "^(http|https)://.*$"
                            },
                            "doi": {
                                "type": "string",
                                "description": "DOI of the tool",
                                "pattern": "^10.\\d{4,9}\\/[^,]+$"
                            },
                            "licence": {
                                "type": ["array", "string"],
                                "description": "Licence of the tool",
                                "items": {
                                    "type": "string"
                                },
                                "uniqueItems": true
                            }
                        },
                        "required": ["description"],
                        "anyOf": [
                            { "required": ["homepage"] },
                            { "required": ["documentation"] },
                            { "required": ["tool_dev_url"] },
                            { "required": ["doi"] }
                        ]
                    }
                }
            }
        }
    },
    "required": ["name", "description", "keywords", "authors", "output", "tools"]
}