Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bioschemas citations #187

Merged
merged 4 commits into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/1.1/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ From [Dublin Core Terms](http://purl.org/dc/terms/) RO-Crate use:

- `conformsTo` mapped to <http://purl.org/dc/terms/conformsTo>

These terms are being proposed by [Bioschemas profile ComputationalWorkflow 0.5-DRAFT](https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21) and [FormalParameter 0.1-DRAFT](https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21) to be integrated into Schema.org:
These terms are being proposed by [Bioschemas profile ComputationalWorkflow 0.5-DRAFT][ComputationalWorkflow profile 0.5] and [FormalParameter 0.1-DRAFT][FormalParameter profile 0.1] to be integrated into Schema.org:

* `ComputationalWorkflow` mapped to <https://bioschemas.org/ComputationalWorkflow>
* `FormalParameter` mapped to <https://bioschemas.org/FormalParameter>
Expand Down
18 changes: 9 additions & 9 deletions docs/1.1/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,16 +187,16 @@ A workflow diagram may still be provided even if there is no programmatic `Softw
## Complying with Bioschemas Computational Workflow profile

Data entities representing _workflows_ (`@type: ComputationalWorkflow`)
SHOULD comply with the Bioschemas [ComputationalWorkflow profile],
SHOULD comply with the Bioschemas [ComputationalWorkflow profile][ComputationalWorkflow profile 0.5],
where possible.

When complying with this profile, the workflow data entities
MUST describe these properties and their related contextual entities:
[name], [programmingLanguage], [creator], [dateCreated], [license], [sdPublisher], [url], [version].

The [ComputationalWorkflow profile] explains the above and list additional properties that a compliant [ComputationalWorkflow] data entity SHOULD include: [citation], [contributor], [creativeWorkStatus], [description], [funding], [hasPart], [isBasedOn], [keywords], [maintainer], [producer], [publisher], [runtimePlatform], [softwareRequirements], [targetProduct]
The [ComputationalWorkflow profile][ComputationalWorkflow profile 0.5] explains the above and list additional properties that a compliant [ComputationalWorkflow][ComputationalWorkflow 0.1] data entity SHOULD include: [citation], [contributor], [creativeWorkStatus], [description], [funding], [hasPart], [isBasedOn], [keywords], [maintainer], [producer], [publisher], [runtimePlatform], [softwareRequirements], [targetProduct]

A data entity conforming to the [ComputationalWorkflow profile] SHOULD declare the versioned profile URI using [conformsTo]:
A data entity conforming to the [ComputationalWorkflow profile][ComputationalWorkflow profile 0.5] SHOULD declare the versioned profile URI using [conformsTo]:

```json
{ "@id": "workflow/alignment.knime",
Expand All @@ -209,16 +209,16 @@ A data entity conforming to the [ComputationalWorkflow profile] SHOULD declare t

### Describing inputs and outputs

The input and output _parameters_ for a workflow or script can be given with `input` and `output` to [FormalParameter]
The input and output _parameters_ for a workflow or script can be given with `input` and `output` to [FormalParameter][FormalParameter 0.1]
contextual entities. Note that this entity usually represent a _potential_ input/output value in a reusable
workflow, much like [function parameter definitions] in general programming.

If complying with the Bioschemas [FormalParameter profile],
the _contextual entities_ for [FormalParameter], referenced by `input` or `output`, MUST describe: [name], [additionalType], [encodingFormat]
If complying with the Bioschemas [FormalParameter profile][FormalParameter profile 0.1],
the _contextual entities_ for [FormalParameter][FormalParameter 0.1], referenced by `input` or `output`, MUST describe: [name], [additionalType], [encodingFormat]

The Bioschemas [FormalParameter profile] explains the above and lists additional properties that can be used, including [description], [valueRequired], [defaultValue] and [identifier].
The Bioschemas [FormalParameter profile][FormalParameter profile 0.1] explains the above and lists additional properties that can be used, including [description], [valueRequired], [defaultValue] and [identifier].

A contextual entity conforming to the [FormalParameter profile] SHOULD declare the versioned profile URI using [conformsTo], e.g.:
A contextual entity conforming to the [FormalParameter profile][FormalParameter profile 0.1] SHOULD declare the versioned profile URI using [conformsTo], e.g.:

```json
{
Expand All @@ -235,7 +235,7 @@ A contextual entity conforming to the [FormalParameter profile] SHOULD declare t

## Complete Workflow Example

The below is an example of an RO-Crate complying with the [Bioschemas ComputationalWorkflow profile 0.5][ComputationalWorkflow profile]:
The below is an example of an RO-Crate complying with the Bioschemas [ComputationalWorkflow profile 0.5]:

```json
{ "@context": "https://w3id.org/ro/crate/1.1/context",
Expand Down
1 change: 0 additions & 1 deletion docs/1.2-DRAFT/context.jsonld
Original file line number Diff line number Diff line change
Expand Up @@ -2638,7 +2638,6 @@
"retrievedOn": "http://purl.org/pav/retrievedOn",
"retrievedBy": "http://purl.org/pav/retrievedBy",
"conformsTo": "http://purl.org/dc/terms/conformsTo",
"sdConformsTo": "https://w3id.org/ro/terms#sdConformsTo",
"@label": "http://www.w3.org/2000/01/rdf-schema#label",
"pcdm": "http://pcdm.org/models#",
"bibo": "http://purl.org/ontology/bibo/",
Expand Down
6 changes: 1 addition & 5 deletions docs/1.2-DRAFT/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ From [Dublin Core Terms](http://purl.org/dc/terms/) RO-Crate use:

- `conformsTo` mapped to <http://purl.org/dc/terms/conformsTo>

These terms are being proposed by [Bioschemas profile ComputationalWorkflow 0.5-DRAFT](https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21) and [FormalParameter 0.1-DRAFT](https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21) to be integrated into Schema.org:
These terms are being proposed by [Bioschemas profile ComputationalWorkflow 1.0-RELEASE][ComputationalWorkflow profile 1.0] and [FormalParameter 1.0-RELEASE][FormalParameter profile 1.0] to be integrated into Schema.org:

* `ComputationalWorkflow` mapped to <https://bioschemas.org/ComputationalWorkflow>
* `FormalParameter` mapped to <https://bioschemas.org/FormalParameter>
Expand All @@ -117,10 +117,6 @@ These terms are being proposed by [Bioschemas profile ComputationalWorkflow 0.5-
{: .note }
> In this specification the proposed Bioschemas terms use the temporary <https://bioschemas.org/> namespace; future releases of RO-Crate may reflect mapping to the <http://schema.org/> namespace.

Additional terms in RO-Crate's own [ro-terms vocabulary][ro-terms]:

* `sdConformsTo` mapped to <https://w3id.org/ro/terms#sdConformsTo> (see [profiles](profiles.md))


## Summary of Coverage

Expand Down
58 changes: 34 additions & 24 deletions docs/1.2-DRAFT/workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,45 +185,48 @@ A workflow diagram may still be provided even if there is no programmatic `Softw
## Complying with Bioschemas Computational Workflow profile

Data entities representing _workflows_ (`@type: ComputationalWorkflow`)
SHOULD comply with the Bioschemas [ComputationalWorkflow profile],
SHOULD comply with the Bioschemas [ComputationalWorkflow profile][ComputationalWorkflow profile 1.0],
where possible.

When complying with this profile, the workflow data entities
MUST describe these properties and their related contextual entities:
[name], [programmingLanguage], [creator], [dateCreated], [license], [sdPublisher], [url], [version].

The [ComputationalWorkflow profile] explains the above and list additional properties that a compliant [ComputationalWorkflow] data entity SHOULD include: [citation], [contributor], [creativeWorkStatus], [description], [funding], [hasPart], [isBasedOn], [keywords], [maintainer], [producer], [publisher], [runtimePlatform], [softwareRequirements], [targetProduct]
The [ComputationalWorkflow profile][ComputationalWorkflow profile 1.0] explains the above and list additional properties that a compliant [ComputationalWorkflow][ComputationalWorkflow 1.0] data entity SHOULD include: [citation], [contributor], [creativeWorkStatus], [description], [funding], [hasPart], [isBasedOn], [keywords], [maintainer], [producer], [publisher], [runtimePlatform], [softwareRequirements], [targetProduct]

A data entity conforming to the [ComputationalWorkflow profile] SHOULD declare the versioned profile URI using [conformsTo]:
A data entity conforming to the [ComputationalWorkflow profile][ComputationalWorkflow profile 1.0] SHOULD declare the versioned profile URI using [conformsTo] [^18]:

```json
{ "@id": "workflow/alignment.knime",
"@type": ["File", "SoftwareSourceCode", "ComputationalWorkflow"],
"conformsTo":
{"@id": "https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21/"},
{"@id": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE"},
"..": ""
}
```

[^18]: This is a liberal interpretation of [conformsTo] as it is the _structured data_ about the workflow (this JSON-LD object) that conforms to the ComputationalWorkflow profile, not the file content of a workflow data entity (`workflow/alignment.knime`). Instead of introducing a `sdConformsTo` similar to [sdPublisher], we here follow the current Bioschemas convention of indicating profile conformance when the JSON-LD is embedded within HTML pages.


### Describing inputs and outputs

The input and output _parameters_ for a workflow or script can be given with `input` and `output` to [FormalParameter]
The input and output _parameters_ for a workflow or script can be given with `input` and `output` to [FormalParameter][FormalParameter 1.0]
contextual entities. Note that this entity usually represent a _potential_ input/output value in a reusable
workflow, much like [function parameter definitions] in general programming.

If complying with the Bioschemas [FormalParameter profile],
the _contextual entities_ for [FormalParameter], referenced by `input` or `output`, MUST describe: [name], [additionalType], [encodingFormat]
If complying with the Bioschemas [FormalParameter profile][FormalParameter profile 1.0],
the _contextual entities_ for [FormalParameter][FormalParameter 1.0], referenced by `input` or `output`, MUST describe: [name], [additionalType], [encodingFormat]

The Bioschemas [FormalParameter profile] explains the above and lists additional properties that can be used, including [description], [valueRequired], [defaultValue] and [identifier].
The Bioschemas [FormalParameter profile][FormalParameter profile 1.0] explains the above and lists additional properties that can be used, including [description], [valueRequired], [defaultValue] and [identifier].

A contextual entity conforming to the [FormalParameter profile] SHOULD declare the versioned profile URI using [conformsTo], e.g.:
A contextual entity conforming to the [FormalParameter profile][FormalParameter profile 1.0] SHOULD declare the versioned profile URI using `conformsTo` e.g.:

```json
{
"@id": "#36aadbd4-4a2d-4e33-83b4-0cbf6a6a8c5b",
"@type": "FormalParameter",
"conformsTo":
{"@id": "https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21/"},
{"@id": "https://bioschemas.org/profiles/FormalParameter/1.0-RELEASE"},
"..": ""
}
```
Expand All @@ -233,7 +236,7 @@ A contextual entity conforming to the [FormalParameter profile] SHOULD declare t

## Complete Workflow Example

The below is an example of an RO-Crate complying with the [Bioschemas ComputationalWorkflow profile 0.5][ComputationalWorkflow profile]:
The below is an example of an RO-Crate complying with the Bioschemas [ComputationalWorkflow profile 1.0]:

```json
{ "@context": "https://w3id.org/ro/crate/1.2-DRAFT/context",
Expand All @@ -254,8 +257,9 @@ The below is an example of an RO-Crate complying with the [Bioschemas Computatio
{
"@id": "workflow/alignment.knime",
"@type": ["File", "SoftwareSourceCode", "ComputationalWorkflow"],
"conformsTo":
{"@id": "https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21/"},
"conformsTo": {
"@id": "https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE"
},
"name": "Sequence alignment workflow",
"programmingLanguage": {"@id": "#knime"},
"creator": {"@id": "#alice"},
Expand All @@ -268,14 +272,16 @@ The below is an example of an RO-Crate complying with the [Bioschemas Computatio
{ "@id": "#6c703fee-6af7-4fdb-a57d-9e8bc4486044"},
{ "@id": "#2f32b861-e43c-401f-8c42-04fd84273bdf"}
],
"sdPublisher": {"@id": "#workflow-hub"},
"sdPublisher": {"@id": "#workflow-repo"},
"url": "http://example.com/workflows/alignment",
"version": "0.5.0"
},
{
"@id": "#36aadbd4-4a2d-4e33-83b4-0cbf6a6a8c5b",
"@type": "FormalParameter",
"conformsTo": {"@id": "https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21/"},
"conformsTo": {
"@id": "https://bioschemas.org/profiles/FormalParameter/1.0-RELEASE"
},
"name": "genome_sequence",
"valueRequired": true,
"additionalType": {"@id": "http://edamontology.org/data_2977"},
Expand All @@ -284,15 +290,19 @@ The below is an example of an RO-Crate complying with the [Bioschemas Computatio
{
"@id": "#6c703fee-6af7-4fdb-a57d-9e8bc4486044",
"@type": "FormalParameter",
"conformsTo": {"@id": "https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21/"},
"conformsTo": {
"@id": "https://bioschemas.org/profiles/FormalParameter/1.0-RELEASE"
},
"name": "cleaned_sequence",
"additionalType": {"@id": "http://edamontology.org/data_2977"},
"encodingFormat": {"@id": "http://edamontology.org/format_2572"}
},
{
"@id": "#2f32b861-e43c-401f-8c42-04fd84273bdf",
"@type": "FormalParameter",
"conformsTo": {"@id": "https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21/"},
"conformsTo": {"@id": "
https://bioschemas.org/profiles/FormalParameter/1.0-RELEASE"
},
"name": "sequence_alignment",
"additionalType": {"@id": "http://edamontology.org/data_1383"},
"encodingFormat": {"@id": "http://edamontology.org/format_1982"}
Expand All @@ -317,34 +327,34 @@ The below is an example of an RO-Crate complying with the [Bioschemas Computatio
"name": "Alice Brown"
},
{
"@id": "#workflow-hub",
"@id": "#workflow-repo",
"@type": "Organization",
"name": "Example Workflow Hub",
"name": "Example Workflow repository",
"url":"http://example.com/workflows/"
},
{
"@id": "http://edamontology.org/format_1929",
"@type": "Thing",
"@type": "DefinedTerm",
"name": "FASTA sequence format"
},
{
"@id": "http://edamontology.org/format_1982",
"@type": "Thing",
"@type": "DefinedTerm",
"name": "ClustalW alignment format"
},
{
"@id": "http://edamontology.org/format_2572",
"@type": "Thing",
"@type": "DefinedTerm",
"name": "BAM format"
},
{
"@id": "http://edamontology.org/data_2977",
"@type": "Thing",
"@type": "DefinedTerm",
"name": "Nucleic acid sequence"
},
{
"@id": "http://edamontology.org/data_1383",
"@type": "Thing",
"@type": "DefinedTerm",
"name": "Nucleic acid sequence alignment"
}
]
Expand Down
19 changes: 13 additions & 6 deletions docs/_includes/references.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,19 @@ and is also rendered into the end of the PDF.
[mainEntityOfPage]: http://schema.org/mainEntityOfPage
[WebPage]: https://schema.org/WebPage

[input]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21#input
[output]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21#output
[FormalParameter]: https://bioschemas.org/types/FormalParameter/0.1-DRAFT-2020_07_21
[ComputationalWorkflow]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21
[ComputationalWorkflow profile]: https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21
[FormalParameter profile]: https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21
[ComputationalWorkflow 0.1]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21
[ComputationalWorkflow 0.1 input]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21#input
[ComputationalWorkflow 0.1 output]: https://bioschemas.org/types/ComputationalWorkflow/0.1-DRAFT-2020_07_21#output
[FormalParameter 0.1]: https://bioschemas.org/types/FormalParameter/0.1-DRAFT-2020_07_21
[ComputationalWorkflow profile 0.5]: https://bioschemas.org/profiles/ComputationalWorkflow/0.5-DRAFT-2020_07_21
[FormalParameter profile 0.1]: https://bioschemas.org/profiles/FormalParameter/0.1-DRAFT-2020_07_21

[ComputationalWorkflow 1.0]: https://bioschemas.org/types/ComputationalWorkflow/1.0-RELEASE
[ComputationalWorkflow 1.0 input]: https://bioschemas.org/types/ComputationalWorkflow/1.0-RELEASE#input
[ComputationalWorkflow 1.0 output]: https://bioschemas.org/types/ComputationalWorkflow/1.0-RELEASE#output
[FormalParameter 1.0]: https://bioschemas.org/types/FormalParameter/1.0-RELEASE
[ComputationalWorkflow profile 1.0]: https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE
[FormalParameter profile 1.0]: https://bioschemas.org/profiles/FormalParameter/1.0-RELEASE

[RFC 2119]: https://tools.ietf.org/html/rfc2119
[RFC 3986]: https://tools.ietf.org/html/rfc3986
Expand Down
2 changes: 1 addition & 1 deletion scripts/schema-context.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ def main():
("funding", "http://schema.org/funding"),
## END

("sdConformsTo", "https://w3id.org/ro/terms#sdConformsTo"),
##("sdConformsTo", "https://w3id.org/ro/terms#sdConformsTo"),

("wasDerivedFrom", "http://www.w3.org/ns/prov#wasDerivedFrom"),

Expand Down