dataset-metadata #15
dataset-metadata #15
Conversation
This is simply a starting point for discussion
BICCN-policies/dataset-metadata.yaml
Outdated
| identifier: REQUIRED | ||
| repository: REQUIRED | ||
| url: REQUIRED | ||
| publications: |
There was a problem hiding this comment.
The generalized version of this is related identifiers of which publications are a subset, see relation types also in table 4 from the previous comment.
There was a problem hiding this comment.
this is going to be a constant tussle, and we should decide whether we want a specific node, or the more general node.
BICCN-policies/dataset-metadata.yaml
Outdated
| email: Recommended # filled from orcid | ||
| name: Recommended # filled from orcid | ||
| affiliations: optional # filled from orcid | ||
| sponsors: |
There was a problem hiding this comment.
A grant number, or funding field seems to be missing here?
There was a problem hiding this comment.
Definitely need a field for Award number, but it would be optional - example case is at Allen Institute we also acknowledge Allen Institute for Brain Science for support, but have no specific award ids
BICCN-policies/dataset-metadata.yaml
Outdated
| name: REQUIRED | ||
| url: RECOMMENDED | ||
| license: | ||
| - url # REQUIRED |
There was a problem hiding this comment.
Potential controlled source? https://spdx.org/licenses/
There was a problem hiding this comment.
Ooh, nice source of license controlled vocabulary.
- Should we log an identifer for the license here, AND the url?
- Custom licenses: Right now in BICCN the policy is the data should all be CC-BY-4.0 if generated by BICCN. HOWEVER, its possible at some point that we ingest some data that has a different license attached for some reason. If that license is a custom license and not included in that list, what do we use this url for?
BICCN-policies/dataset-metadata.yaml
Outdated
| description: REQUIRED | ||
| contributors: # required for author and contact | ||
| - orcid: # REQUIRED | ||
| roles: # REQUIRED from https://casrai.org/credit/ + maintainer, contact |
There was a problem hiding this comment.
Thanks for the link to casrai.org/credit - looks usefule! Would you just want to use the role alone, or include optional additional text, much as is provided in an acknowledgement in a paper?
| @@ -0,0 +1,85 @@ | |||
| identifier: REQUIRED ## Post upload (or during dandi organize) | |||
| name: REQUIRED | |||
There was a problem hiding this comment.
Prefer to call this "title" to encourage people to use a formal title, but doesn't matter so long as people provide appropriate info.
BICCN-policies/dataset-metadata.yaml
Outdated
| identifier: REQUIRED ## Post upload (or during dandi organize) | ||
| name: REQUIRED | ||
| description: REQUIRED | ||
| contributors: # required for author and contact |
There was a problem hiding this comment.
Add "recommended for other major contributors"
| name: REQUIRED | ||
| description: REQUIRED | ||
| contributors: # required for author and contact | ||
| - orcid: # REQUIRED |
There was a problem hiding this comment.
One comment - PIs likely to have an ORCID, but the other contributors may not have them such as the lead RA who generated the data. What if that lead RA has left the lab and can't be convinced to create an ORCID?
ORCIDs seem like they would be good, but I can see cases where we won't have them, because they have to be created by the individual - unless someone knows of a way around that?
There was a problem hiding this comment.
for the moment we are going with orcid, but will allow people to add name/email/affiliation.
| releaseDate: REQUIRED | ||
| associatedData: | ||
| - name: REQUIRED | ||
| identifier: REQUIRED |
There was a problem hiding this comment.
some data may have both an identifier and a DOI
| publications: | ||
| - url: REQUIRED # doi preferred | ||
| identifiers: RECOMMENDED # PMCID | ||
| relation: RECOMMENDED |
There was a problem hiding this comment.
Is there a controlled vocab for this?
BICCN-policies/dataset-metadata.yaml
Outdated
| ## Post publication (i.e. added by DANDI) | ||
| version: REQUIRED | ||
| releaseDate: REQUIRED | ||
| associatedData: |
There was a problem hiding this comment.
Associated data is set up here to refer to the raw data. The associated data has a repository and url.
During the collection of dataset metadata from BICCN labs, several labs provided me with an alternate data access URL like brainome.org. Where should we model this alternate/related data access URL?
BICCN-policies/dataset-metadata.yaml
Outdated
| relation: RECOMMENDED | ||
| doi: REQUIRED | ||
| url: REQUIRED | ||
| repository: REQUIRED |
There was a problem hiding this comment.
Why is there a second repository listed? Did I misinterpret the first "Associated Data" section?
BICCN-policies/dataset-metadata.yaml
Outdated
| url: RECOMMENDED | ||
| license: | ||
| - url # REQUIRED | ||
| keywords: [key1, key2,] |
There was a problem hiding this comment.
Related to keywords - we would want to capture the modality and relevant technique(s) for BICCN purposes.
@almightyyakob just a ping to the subfield.
|
i'll take another pass through this soon and align as much as possible with the DATS object. |
This is simply a starting point for discussion