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

Author fields on annotaion; BICAN ext no additional props #109

Merged
merged 3 commits into from
May 14, 2024
Merged

Author fields on annotaion; BICAN ext no additional props #109

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
097ef62
Author fields on annotaion; BICAN ext no additional props
dosumis Apr 4, 2024
7ce1d4f
example data fixed according to the schema
hkir-dev Apr 5, 2024
d6ee0d1
Update general_schema.json
dosumis Apr 5, 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
1 change: 1 addition & 0 deletions BICAN_extension.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
}
},
"Annotation": {
"additionalProperties": false,
"properties": {
"cell_set_accession": {
"type": "string",
Expand Down
6 changes: 5 additions & 1 deletion general_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
},
"Annotation": {
"type": "object",
"description": "A collection of fields recording a cell type/class/state annotation on some set os cells, supporting evidence and provenance. As this is intended as a general schema, compulsory fields are kept to a minimum. However, tools using this schema are encouarged to specify a larger set of compulsory fields for publication. \n\nNote: This schema deliberately allows for additional fields in order to support ad hoc user fields, new formal schema extensions and project/tool specific metadata.",
"description": "A collection of fields recording a cell type/class/state annotation on some set of cells, supporting evidence and provenance. As this is intended as a general schema, compulsory fields are kept to a minimum. However, tools using this schema are encouarged to specify a larger set of compulsory fields for publication. \n\nNote: This schema deliberately allows for additional fields in order to support ad hoc user fields, new formal schema extensions and project/tool specific metadata.",
"required": [
"labelset",
"cell_label"
Expand Down Expand Up @@ -128,6 +128,10 @@
"items": {
"type": "string",
"description": "List of synonyms"
},
"author_annotation_fields": {
Copy link
Collaborator

@hkir-dev hkir-dev Apr 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems nesting is wrong, this element is inside synonyms.

Also, Should this be an array of objects? Such as:

"author_annotation_fields": {
            "type": "array",
            "description": "A set of author defined key value pairs annotating the cell set. The names and aims of these fields MUST not clash with annotationThis schema accepts author defined fields.",
            "items": {
                  "type": "object",
                  "description": "Author defined key value pairs annotating the cell set. The names and aims of these fields MUST not clash with annotationThis schema accepts author defined fields."
             }
          }

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Certainly shouldn't be in synonym!

I think it should be an object (dictionary) rather than a list.

"type": "object",
"description": "A set of author defined key value pairs annotating the cell set. The names and aims of these fields MUST not clash with annotationThis schema accepts author defined fields."
}
}
}
Expand Down
Loading