Skip to content

Commit

Permalink
Merge branch 'rebrand-to-nf-schema' into rework-fromSamplesheet
Browse files Browse the repository at this point in the history
  • Loading branch information
nvnieuwk committed Mar 20, 2024
2 parents 4970b54 + 0ed3d2b commit 18ae17c
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/nextflow_schema/create_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ nf-core schema build

!!! warning

The current version of `nf-core` tools (v2.12.1) does not support the new schema draft used in `nf-schemaunning this command after building the schema will convert the schema to the right draft:
The current version of `nf-core` tools (v2.12.1) does not support the new schema draft used in `nf-schema`. Running this command after building the schema will convert the schema to the right draft:

```bash
sed -i -e 's/http:\/\/json-schema.org\/draft-07\/schema/https:\/\/json-schema.org\/draft\/2020-12\/schema/g' -e 's/definitions/defs/g' nextflow_schema.json
Expand Down
6 changes: 3 additions & 3 deletions docs/nextflow_schema/nextflow_schema_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ hide:
You can see an example JSON Schema for a Nextflow pipeline `nextflow_schema.json` file below.

This file was generated from the nf-core pipeline template, using `nf-core create`.
It is used as a test fixture in the nf-schemakage [here](https://github.com/nextflow-io/nf-snf-schemaster/plugins/nf-schemnf-schemaources/nextflow_schema.json).
It is used as a test fixture in the nf-schema package [here](https://github.com/nextflow-io/nf-schema/master/plugins/nf-schema/resources/nextflow_schema.json).

!!! note

More examples can be found in the plugin [`testResources` directory](https://github.com/nextflow-io/nf-schemab/master/plugins/nf-snf-schematResources/).
More examples can be found in the plugin [`testResources` directory](https://github.com/nextflow-io/nf-schema/master/plugins/nf-schema/testResources/).

```json
--8<-- "plugins/nf-schema/testResources/nextflow_schema.json"
--8<-- "plugins/nf-schema/src/testResources/nextflow_schema.json"
```
4 changes: 2 additions & 2 deletions docs/nextflow_schema/sample_sheet_schema_specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Schema specification for sample sheet validation

# Sample sheet schema specification

Sample sheet schema files are used by the nf-schemagin for validation of sample sheet contents and type conversion / channel generation.
Sample sheet schema files are used by the nf-schema plugin for validation of sample sheet contents and type conversion / channel generation.

The Nextflow schema syntax is based on the JSON schema standard.
You can find more information about JSON Schema here:
Expand Down Expand Up @@ -94,4 +94,4 @@ For example:
```

will convert the `field` value to a meta value, resulting in the channel `[[id:value]...]`
See [here](https://github.com/nextflow-io/nf-schemab/ce3aef60e5103ea4798375fe6c59bae41b7d2a25/plugins/nf-scheschemctResources/schema_input.json#L10-L25) for an example in the sample sheet.
See [here](https://github.com/nextflow-io/nf-schema/blob/ce3aef60e5103ea4798375fe6c59bae41b7d2a25/plugins/nf-schema/src/testResources/schema_input.json#L10-L25) for an example in the sample sheet.
2 changes: 1 addition & 1 deletion docs/schema_input.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/nextflow-io/nf-schemater/plugins/nf-snf-schematResources/schema_input.json",
"$id": "https://raw.githubusercontent.com/nextflow-io/nf-schema/master/plugins/nf-schema/src/testResources/schema_input.json",
"title": "Samplesheet validation schema",
"description": "Schema for the samplesheet used in this pipeline",
"type": "object",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/nf-schemample/master/assets/schema_input.json",
"title": "nf-schemample - params.input schema",
"$id": "https://raw.githubusercontent.com/nf-schema/example/master/assets/schema_input.json",
"title": "nf-schema example - params.input schema",
"description": "Schema for the file provided with params.input",
"type": "array",
"items": {
Expand Down

0 comments on commit 18ae17c

Please sign in to comment.