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

Add generation for resolved profiles #13

Closed
wants to merge 1 commit into from
Closed
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
44 changes: 44 additions & 0 deletions profile/arc-cwl-workflow.generated.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
| Property | Required | Cardinality | Expected Type | Description | Source Profile |
|----------|----------|-------------|---------------|-------------|----------------|
| <h4>Required Properties</h4> | | | | | |
| **`@context`** | Required | ONE | [schema.org/URL](https://schema.org/URL) | Used to provide the context (namespaces) for the JSON-LD file. Not needed in other serialisations. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`@type`** | Required | 4 | [schema.org/Text](https://schema.org/Text)<br>AND [schema.org/SoftwareSourceCode](https://schema.org/SoftwareSourceCode)<br>AND [bioschemas.org/ComputationalWorkflow](https://bioschemas.org/types/ComputationalWorkflow)<br>AND [bioschemas.org/LabProtocol](https://bioschemas.org/types/LabProtocol) | Schema.org/Bioschemas class for the resource declared using JSON-LD syntax. For other serialisations please use the appropriate mechanism. While it is permissible to provide multiple types, it is preferred to use a single type. | **THIS PROFILE** |
| **`@id`** | Required | ONE | [IRI](https://datatracker.ietf.org/doc/html/rfc3987#section-2) | Used to distinguish the resource being described in JSON-LD. For other serialisations use the appropriate approach. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`dct:conformsTo`** | Required | 2 | [IRI](https://datatracker.ietf.org/doc/html/rfc3987#section-2) | Used to state the profiles that the markup relates to. MUST be 'https://bioschemas.org/profiles/ComputationalWorkflow/1.0-RELEASE' AND `<insert our LabProtocol profile IRI here>` | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`creator`** | Required | MANY | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | The creator/author of this CreativeWork. This is the same as the Author property for CreativeWork. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`dateCreated`** | Required | ONE | [schema.org/Date](https://schema.org/Date)<br>OR [schema.org/DateTime](https://schema.org/DateTime) | The date on which the CreativeWork was created or the item was added to a DataFeed. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`input`** | Required | MANY | [bioschemas.org/FormalParameter](https://bioschemas.org/types/FormalParameter) | An input required to use the computational workflow (eg. Excel spreadsheet, BAM file) | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`license`** | Required | MANY | [schema.org/CreativeWork](https://schema.org/CreativeWork)<br>OR [schema.org/URL](https://schema.org/URL) | A license document that applies to this content, typically indicated by URL. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`name`** | Required | ONE | [schema.org/Text](https://schema.org/Text) | The name of the item. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`output`** | Required | MANY | [bioschemas.org/FormalParameter](https://bioschemas.org/types/FormalParameter) | An output produced by the workflow | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`programmingLanguage`** | Required | MANY | [schema.org/ComputerLanguage](https://schema.org/ComputerLanguage)<br>OR [schema.org/Text](https://schema.org/Text) | The computer programming language | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`sdPublisher`** | Required | ONE | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | The host site for the ComputationalWorkflow | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`url`** | Required | ONE | [schema.org/URL](https://schema.org/URL) | URL of the item. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`version`** | Required | ONE | [schema.org/Text](https://schema.org/Text)<br>OR [schema.org/Number](https://schema.org/Number) | Version is a release. The date modified may not warrant a release, but last date modified and access to all versions is important | https://bioschemas.org/profiles/ComputationalWorkflow |
| <h4>Recommended Properties</h4> | | | | | |
| **`citation`** | Recommended | ANY | [schema.org/CreativeWork](https://schema.org/CreativeWork)<br>OR [schema.org/Text](https://schema.org/Text) | A citation or reference to another creative work, such as another publication, web page, scholarly article, etc. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`contributor`** | Recommended | ANY | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | A secondary contributor to the CreativeWork or Event. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`creativeWorkStatus`** | Recommended | ONE | [schema.org/DefinedTerm](https://schema.org/DefinedTerm)<br>OR [schema.org/Text](https://schema.org/Text) | The status of a creative work in terms of its stage in a lifecycle. Example terms include Incomplete, Draft, Published, Obsolete. Some organizations define a set of terms for the stages of their publication lifecycle. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`description`** | Recommended | ONE | [schema.org/Text](https://schema.org/Text) | A description of the item. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`documentation`** | Recommended | ANY | [schema.org/CreativeWork](https://schema.org/CreativeWork)<br>OR [schema.org/URL](https://schema.org/URL) | Documentation describing the ComputationalWorkflow and its use. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`funding`** | Recommended | ANY | [schema.org/Grant](https://schema.org/Grant) | The funding for the workflow | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`hasPart`** | Recommended | ANY | [schema.org/CreativeWork](https://schema.org/CreativeWork) | The tools/scripts that are (potentially) used by the ComputationalWorkflow when it is executed, The parts are not ordered; they normally correspond to steps in the workflow, there is no specified mapping. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`isBasedOn`** | Recommended | ONE | [schema.org/CreativeWork](https://schema.org/CreativeWork)<br>OR [schema.org/Product](https://schema.org/Product)[schema.org/URL](https://schema.org/URL) | This is normally another ComputationalWorkflow, but may also be, for example, a paper or a lab protocol. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`keywords`** | Recommended | ONE | [schema.org/Text](https://schema.org/Text) | Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`maintainer`** | Recommended | ANY | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | A maintainer of a Dataset, software package (SoftwareApplication), or other Project. A maintainer is a Person or Organization that manages contributions to, and/or publication of, some (typically complex) artifact. It is common for distributions of software and data to be based on “upstream” sources. When maintainer is applied to a specific version of something e.g. a particular version or packaging of a Dataset, it is always possible that the upstream source has a different maintainer. The isBasedOn property can be used to indicate such relationships between datasets to make the different maintenance roles clear. Similarly in the case of software, a package may have dedicated maintainers working on integration into software distributions such as Ubuntu, as well as upstream maintainers of the underlying work. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`producer`** | Recommended | ANY | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | The person or organization who produced the workflow | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`publisher`** | Recommended | ANY | [schema.org/Organization](https://schema.org/Organization)<br>OR [schema.org/Person](https://schema.org/Person) | Where it came came from, e.g. Galaxy, github, or WF Hub if uploaded | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`runtimePlatform`** | Recommended | ANY | [schema.org/Text](https://schema.org/Text) | Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). Supersedes runtime. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`softwareRequirements`** | Recommended | ANY | [schema.org/Text](https://schema.org/Text) | Renaming schema.org/requirements as softwareRequirements | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`targetProduct`** | Recommended | ANY | [schema.org/SoftwareApplication](https://schema.org/SoftwareApplication) | Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`intendedUse`** | Recommended | ONE | [schema.org/DefinedTerm](https://schema.org/DefinedTerm)<br>OR [schema.org/Text](https://schema.org/Text)<br>OR [schema.org/URL](https://schema.org/URL) | The protocol type as an ontology term | isa-ro-crate-profile/LabProtocol |
| <h4>Optional Properties</h4> | | | | | |
| **`alternateName`** | Optional | ANY | [schema.org/Text](https://schema.org/Text) | An alias for the item. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`conditionsOfAccess`** | Optional | ONE | [schema.org/Text](https://schema.org/Text) | Conditions that affect the availability of, or method(s) of access to, an item. Typically used for real world items such as an ArchiveComponent held by an ArchiveOrganization. This property is not suitable for use as a general Web access control mechanism. It is expressed only in natural language. For example “Available by appointment from the Reading Room” or “Accessible only from logged-in accounts “. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`dateModified`** | Optional | ONE | [schema.org/Date](https://schema.org/Date)<br>OR [schema.org/DateTime](https://schema.org/DateTime) | The date on which the CreativeWork was most recently modified or when the item’s entry was modified within a DataFeed. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`datePublished`** | Optional | ONE | [schema.org/Date](https://schema.org/Date)<br>OR [schema.org/DateTime](https://schema.org/DateTime) | Date of first broadcast/publication. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`encodingFormat`** | Optional | ANY | [schema.org/Text](https://schema.org/Text)<br>OR [schema.org/URL](https://schema.org/URL) | Should be the type of the workflow | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`identifier`** | Optional | ANY | [schema.org/Text](https://schema.org/Text)<br>OR [schema.org/PropertyValue](https://schema.org/PropertyValue)<br>OR [schema.org/URL](https://schema.org/URL) | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See background notes for more details. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`image`** | Optional | ANY | [schema.org/ImageObject](https://schema.org/ImageObject)<br>OR [schema.org/URL](https://schema.org/URL) | An image of the item. This can be a URL or a fully described ImageObject. | https://bioschemas.org/profiles/ComputationalWorkflow |
| **`comment`** | Recommended | ANY | [schema.org/Comment](https://schema.org/Comment) | | isa-ro-crate-profile/LabProtocol |
| **`computationalTool`** | Recommended | ANY | [schema.org/SoftwareApplication](https://schema.org/SoftwareApplication) | Software or tool used as part of the lab protocol to complete a part of it. | isa-ro-crate-profile/LabProtocol |
Loading