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.

Sign up for GitHub

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

Updates for the UseCase schema #42

Merged
merged 12 commits into from
Dec 17, 2024
Merged

Updates for the UseCase schema #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
426e556
Update poetry lock
caufieldjh Dec 17, 2024
551a687
Set use_case_category in UseCase to multivalued
caufieldjh Dec 17, 2024
d237fa9
Expand descriptions for UseCaseCategory
caufieldjh Dec 17, 2024
cf564c0
Minor update to standards_and_tools_for_dgp_use slot
caufieldjh Dec 17, 2024
cb6f7e1
oops, description goes in description slot
caufieldjh Dec 17, 2024
1b91749
Update project artifacts
caufieldjh Dec 17, 2024
99d9fc7
Update UseCase examples
caufieldjh Dec 17, 2024
b9e2ae7
Add prefixes to categories in examples
caufieldjh Dec 17, 2024
02660f6
Another example fix
caufieldjh Dec 17, 2024
6e16472
Change category in example
caufieldjh Dec 17, 2024
3ee902e
Update description of category slot
caufieldjh Dec 17, 2024
7269583
Fix Org example
caufieldjh Dec 17, 2024
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
21 changes: 11 additions & 10 deletions docs/UseCase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:UseCase](https://w3id.org
UseCase --> "1" UseCaseCategory : use_case_category
UseCase --> "1..*" UseCaseCategory : use_case_category
click UseCaseCategory href "../UseCaseCategory"
Expand All @@ -147,17 +147,17 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:UseCase](https://w3id.org

| Name | Cardinality and Range | Description | Inheritance |
| --- | --- | --- | --- |
| [use_case_category](use_case_category.md) | 1 <br/> [UseCaseCategory](UseCaseCategory.md) | Category of the UseCase | direct |
| [use_case_category](use_case_category.md) | 1..* <br/> [UseCaseCategory](UseCaseCategory.md) | Category of the UseCase | direct |
| [known_limitations](known_limitations.md) | 0..1 <br/> [String](String.md) | Any current obstacles to implementing this use case | direct |
| [relevance_to_dgps](relevance_to_dgps.md) | * <br/> [DataGeneratingProject](DataGeneratingProject.md) | Relevance of the use case to one or more DGPs | direct |
| [data_topics](data_topics.md) | * <br/> [DataTopic](DataTopic.md) | Relevance of the use case to one or more data topics | direct |
| [data_substrates](data_substrates.md) | * <br/> [DataSubstrate](DataSubstrate.md) | Relevance of the use case to one or more data substrates | direct |
| [standards_and_tools_for_dgp_use](standards_and_tools_for_dgp_use.md) | * <br/> [DataStandardOrTool](DataStandardOrTool.md) | List of identifiers of standards and tools; those planned to be used, or alre... | direct |
| [alternative_standards_and_tools](alternative_standards_and_tools.md) | * <br/> [DataStandardOrTool](DataStandardOrTool.md) | List of identifiers of standards and tools; those not explicitly planned to b... | direct |
| [enables](enables.md) | * <br/> [UseCase](UseCase.md) | Other use case(s) this use case supports or makes possible | direct |
| [enables](enables.md) | * <br/> [UseCase](UseCase.md) | List of other use case(s) this use case supports or makes possible | direct |
| [involved_in_experimental_design](involved_in_experimental_design.md) | 0..1 <br/> [Boolean](Boolean.md) | True if use case is likely to be implemented as part of an experimental proce... | direct |
| [involved_in_metadata_management](involved_in_metadata_management.md) | 0..1 <br/> [Boolean](Boolean.md) | True if use case is likely to be implemented as part of metadata indexing, sa... | direct |
| [involved_in_quality_control](involved_in_quality_control.md) | 0..1 <br/> [Boolean](Boolean.md) | True is use case is likely to be implemented as part of data validation opera... | direct |
| [involved_in_quality_control](involved_in_quality_control.md) | 0..1 <br/> [Boolean](Boolean.md) | A value of True indicates a use case is likely to be implemented as part of d... | direct |
| [xref](xref.md) | * <br/> [Uriorcurie](Uriorcurie.md) | URI of corresponding class in an ontology of experimental procedures, in CURI... | direct |
| [id](id.md) | 1 <br/> [Uriorcurie](Uriorcurie.md) | A unique identifier for a thing | [NamedThing](NamedThing.md) |
| [category](category.md) | 0..1 <br/> [CategoryType](CategoryType.md) | Name of the high level ontology class in which this entity is categorized | [NamedThing](NamedThing.md) |
Expand Down Expand Up @@ -264,7 +264,7 @@ attributes:
use_case_category:
name: use_case_category
description: Category of the UseCase. Not all projects will incorporate use cases
in all categories.
in all categories. This is multivalued, as a use case may span categories.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
is_a: node_property
Expand All @@ -275,6 +275,7 @@ attributes:
- UseCase
range: UseCaseCategory
required: true
multivalued: true
known_limitations:
name: known_limitations
description: Any current obstacles to implementing this use case. This could be
Expand Down Expand Up @@ -330,8 +331,8 @@ attributes:
name: standards_and_tools_for_dgp_use
description: List of identifiers of standards and tools; those planned to be used,
or already in use, by one or more Bridge2AI DGPs in addressing this use case,
from those in the Standards Registry, or TBD if standards/tools not yet finalized
for this use case.
from those in the Standards Registry. If no value is provided here, the use
case may not have a direct relationship to a standard or tool.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
is_a: node_property
Expand Down Expand Up @@ -359,7 +360,7 @@ attributes:
multivalued: true
enables:
name: enables
description: Other use case(s) this use case supports or makes possible.
description: List of other use case(s) this use case supports or makes possible.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
is_a: node_property
Expand Down Expand Up @@ -399,8 +400,8 @@ attributes:
range: boolean
involved_in_quality_control:
name: involved_in_quality_control
description: True is use case is likely to be implemented as part of data validation
operations.
description: A value of True indicates a use case is likely to be implemented
as part of data validation operations.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
is_a: node_property
Expand Down
28 changes: 20 additions & 8 deletions docs/UseCaseCategory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@



_Category of use case._
_Category of use case. These define the high-level purpose of a task or activity as part of a broader research effort or other data-related project. They are not mutually exclusive and one use case may involve multiple categories._



Expand Down Expand Up @@ -57,28 +57,40 @@ URI: [UseCaseCategory](UseCaseCategory.md)
<details>
```yaml
name: UseCaseCategory
description: Category of use case.
description: Category of use case. These define the high-level purpose of a task or
activity as part of a broader research effort or other data-related project. They
are not mutually exclusive and one use case may involve multiple categories.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
permissible_values:
acquisition:
text: acquisition
description: Acquisition
description: Acquisition. The use case involves the collection of data from one
or more sources, including data generation, data capture, and data entry.
integration:
text: integration
description: Integration
description: Integration. The use case involves the combination of data from multiple
sources, including data harmonization, data linkage, and data aggregation.
standardization:
text: standardization
description: Standardization
description: Standardization. The use case involves the application of standards
to data, including data normalization, data validation, and quality control.
modeling:
text: modeling
description: Modeling
description: Modeling. The use case involves the development of models, including
predictive models, statistical models, and machine learning models.
application:
text: application
description: Application
description: Application. The use case involves the use of data for a specific
scientific or otherwise productive purpose, including data analysis, data visualization,
and data interpretation. This also includes clinical decision support, patient
care, and other applications of data in a biomedical context.
assessment:
text: assessment
description: Assessment
description: Assessment. The use case involves the evaluation of data quality,
data provenance, and data utility, including the assessment of standards, data
tools, and data resources. Note this differs from the standardization category,
which involves the application of standards to data.

```
</details>
2 changes: 1 addition & 1 deletion docs/UseCaseContainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ from_schema: https://w3id.org/bridge2ai/standards-schema-all
attributes:
use_cases:
name: use_cases
description: Collection of associated use cases
description: Collection of associated use cases.
from_schema: https://w3id.org/bridge2ai/standards-schema-all
rank: 1000
alias: use_cases
Expand Down
22 changes: 11 additions & 11 deletions docs/category.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:category](https://w3id.or

| Name | Description | Modifies Slot |
| --- | --- | --- |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [Organization](Organization.md) | Represents a group or organization related to or responsible for one or more ... | no |
| [UseCase](UseCase.md) | Represents a use case for Bridge2AI standards | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [NamedThing](NamedThing.md) | A generic grouping for any identifiable entity | no |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [DataTopic](DataTopic.md) | Represents a general data topic for Bridge2AI data or the tools/standards app... | no |
| [NamedThing](NamedThing.md) | A generic grouping for any identifiable entity | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [DataSubstrate](DataSubstrate.md) | Represents a data substrate for Bridge2AI data | no |
| [DataTopic](DataTopic.md) | Represents a general data topic for Bridge2AI data or the tools/standards app... | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [Organization](Organization.md) | Represents a group or organization related to or responsible for one or more ... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [UseCase](UseCase.md) | Represents a use case for Bridge2AI standards | no |
| [AnatomicalEntity](AnatomicalEntity.md) | A subcellular location, cell type or gross anatomical part | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |



Expand Down
14 changes: 7 additions & 7 deletions docs/collection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:collection](https://w3id.

| Name | Description | Modifies Slot |
| --- | --- | --- |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |



Expand Down
14 changes: 7 additions & 7 deletions docs/concerns_data_topic.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:concerns_data_topic](http

| Name | Description | Modifies Slot |
| --- | --- | --- |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |



Expand Down
22 changes: 11 additions & 11 deletions docs/contribution_date.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,22 +28,22 @@ URI: [https://w3id.org/bridge2ai/standards-schema-all/:contribution_date](https:

| Name | Description | Modifies Slot |
| --- | --- | --- |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |
| [Organization](Organization.md) | Represents a group or organization related to or responsible for one or more ... | no |
| [UseCase](UseCase.md) | Represents a use case for Bridge2AI standards | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [NamedThing](NamedThing.md) | A generic grouping for any identifiable entity | no |
| [ReferenceDataOrDataset](ReferenceDataOrDataset.md) | Represents a resource in the Bridge2AI Standards Registry serving as a standa... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [DataStandard](DataStandard.md) | Represents a general purpose standard in the Bridge2AI Standards Registry | no |
| [DataTopic](DataTopic.md) | Represents a general data topic for Bridge2AI data or the tools/standards app... | no |
| [NamedThing](NamedThing.md) | A generic grouping for any identifiable entity | no |
| [SoftwareOrTool](SoftwareOrTool.md) | Represents a piece of software or computational tool in the Bridge2AI Standar... | no |
| [DataSubstrate](DataSubstrate.md) | Represents a data substrate for Bridge2AI data | no |
| [DataTopic](DataTopic.md) | Represents a general data topic for Bridge2AI data or the tools/standards app... | no |
| [DataStandardOrTool](DataStandardOrTool.md) | Represents a standard or tool in the Bridge2AI Standards Registry | no |
| [Organization](Organization.md) | Represents a group or organization related to or responsible for one or more ... | no |
| [OntologyOrVocabulary](OntologyOrVocabulary.md) | A set of concepts and categories, potentially defined or accompanied by their... | no |
| [Registry](Registry.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [TrainingProgram](TrainingProgram.md) | Represents a training program for skills and experience related to standards ... | no |
| [ModelRepository](ModelRepository.md) | Represents a resource in the Bridge2AI Standards Registry serving to curate a... | no |
| [ReferenceImplementation](ReferenceImplementation.md) | Represents an implementation of one or more standards or tools in the Bridge2... | no |
| [UseCase](UseCase.md) | Represents a use case for Bridge2AI standards | no |
| [AnatomicalEntity](AnatomicalEntity.md) | A subcellular location, cell type or gross anatomical part | no |
| [BiomedicalStandard](BiomedicalStandard.md) | Represents a standard in the Bridge2AI Standards Registry with particular app... | no |



Expand Down
Loading
Loading