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

get codemeta.tsv to load (displayOrder, mostly) #7844 #553

Closed
wants to merge 6 commits 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
1 change: 1 addition & 0 deletions doc/sphinx-guides/source/user/appendix.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,6 @@ Detailed below are what metadata schemas we support for Citation and Domain Spec
`Virtual Observatory (VO) Discovery and Provenance Metadata <http://perma.cc/H5ZJ-4KKY>`__ (`see .tsv version <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/astrophysics.tsv>`__).
- `Life Sciences Metadata <https://docs.google.com/spreadsheet/ccc?key=0AjeLxEN77UZodHFEWGpoa19ia3pldEFyVFR0aFVGa0E#gid=2>`__: based on `ISA-Tab Specification <https://isa-specs.readthedocs.io/en/latest/isamodel.html>`__, along with controlled vocabulary from subsets of the `OBI Ontology <http://bioportal.bioontology.org/ontologies/OBI>`__ and the `NCBI Taxonomy for Organisms <http://www.ncbi.nlm.nih.gov/Taxonomy/taxonomyhome.html/>`__ (`see .tsv version <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/biomedical.tsv>`__).
- `Journal Metadata <https://docs.google.com/spreadsheets/d/13HP-jI_cwLDHBetn9UKTREPJ_F4iHdAvhjmlvmYdSSw/edit#gid=8>`__: based on the `Journal Archiving and Interchange Tag Set, version 1.2 <https://jats.nlm.nih.gov/archiving/tag-library/1.2/chapter/how-to-read.html>`__ (`see .tsv version <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/journals.tsv>`__).
- `CodeMeta Software Metadata <https://docs.google.com/spreadsheets/d/e/2PACX-1vTE-aSW0J7UQ0prYq8rP_P_AWVtqhyv46aJu9uPszpa9_UuOWRsyFjbWFDnCd7us7PSIpW7Qg2KwZ8v/pub>`__: based on the `CodeMeta Software Metadata Schema, version 2.0 <https://codemeta.github.io/terms/>`__ (`see .tsv version <https://github.com/IQSS/dataverse/blob/master/scripts/api/data/metadatablocks/codemeta.tsv>`__)

See also the `Dataverse Software 4.0 Metadata Crosswalk: DDI, DataCite, DC, DCTerms, VO, ISA-Tab <https://docs.google.com/spreadsheets/d/10Luzti7svVTVKTA-px27oq3RxCUM-QbiTkm8iMd5C54/edit?usp=sharing>`__ document and the :doc:`/admin/metadatacustomization` section of the Admin Guide.
40 changes: 40 additions & 0 deletions scripts/api/data/metadatablocks/codemeta.tsv
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
#metadataBlock name dataverseAlias displayName blockURI
codeMeta20 Software Metadata (CodeMeta v2.0) https://codemeta.github.io/terms/
#datasetField name title description watermark fieldType displayOrder displayFormat advancedSearchField allowControlledVocabulary allowmultiples facetable displayoncreate required parent metadatablock_id termURI
softwareVersion Software version Version of the software instance, usually following some convention like SemVer etc. e.g. 0.2.1 or 1.3 or 2021.1 etc text 0 v#VALUE TRUE FALSE FALSE TRUE TRUE FALSE codeMeta20 https://schema.org/softwareVersion
developmentStatus Development Status Description of development status, e.g. work in progress (wip), active, inactive, suspended. See repostatus.org for more information. text 1 <a href='https://www.repostatus.org/##VALUE'><img src='https://www.repostatus.org/badges/latest/#VALUE.svg' alt='#VALUE '/></a> TRUE TRUE FALSE TRUE FALSE FALSE codeMeta20
codeRepository Code Repository Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, etc.). https://... url 2 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> TRUE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/codeRepository
programmingLanguage Programming Language The programming language(s) used to implement the software (e.g. Python, C++, Matlab, Fortran, Java, Julia,...) text 3 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/programmingLanguage
operatingSystem Operating Systems Operating systems supported (e.g. Windows 10, OSX 11.3, Android 11). text 4 FALSE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/operatingSystem
Copy link
Owner

@poikilotherm poikilotherm Jul 22, 2022

Choose a reason for hiding this comment

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

question: As far as I understood the spec, the compound parent field should be type "none". Would "text" cause a problem? Would that be another valid type? Is that type important after all?

(This is an interesting question despite I switched this field back to a normal, non-compound text field)

Copy link
Author

Choose a reason for hiding this comment

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

@poikilotherm whoops! You're right. Seems like it should be "none". Sorry, I was in a hurry and just trying to get the thing to load. These TSVs are a pain in the neck! 😄

operatingSystemName Name The supported operating systems name Windows, Mac OS X, Linux, Android, ... text 0 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE operatingSystem codeMeta20
operatingSystemVersion Version The supported operating systems version text 1 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE operatingSystem codeMeta20
applicationCategory Application Category Type of software application, e.g. Simulation, Analysis, Visualisation. text 0 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/applicationCategory
applicationSubCategory Application Subcategory Subcategory of the application, e.g. Arcade Game. text 1 #VALUE TRUE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/applicationSubCategory
softwareHelp Software Help/Documentation Link to help texts or documentation https://... url 5 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/softwareHelp
buildInstructions Build instructions Link to installation instructions/documentation https://... url 6 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE TRUE FALSE FALSE codeMeta20
runtimePlatform Runtime Platform Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0). Supersedes runtime. text 7 #VALUE TRUE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/runtimePlatform
targetProduct Target Product Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. text 8 #VALUE FALSE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/targetProduct
softwareRequirements Software Requirements Required software dependencies none 9 FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/softwareRequirements
softwareRequirementsName Name Name or title of the required software/library text 0 #VALUE FALSE FALSE FALSE FALSE FALSE softwareRequirements codeMeta20
softwareRequirementsVersion Version Version of the required software/library text 1 #VALUE FALSE FALSE FALSE FALSE FALSE softwareRequirements codeMeta20
softwareRequirementsUrl URL Link to required software/library https://... url 2 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE softwareRequirements codeMeta20
softwareSuggestions Software Suggestions Optional dependencies, e.g. for optional features, code development, etc. none 10 FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20
softwareSuggestionsName Name Name or title of the optional software/library text 0 #VALUE FALSE FALSE FALSE FALSE FALSE softwareSuggestions codeMeta20
softwareSuggestionsVersion Version Version of the optional software/library text 1 #VALUE FALSE FALSE FALSE FALSE FALSE softwareSuggestions codeMeta20
softwareSuggestionsUrl URL Link to optional software/library https://... url 2 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE softwareSuggestions codeMeta20
permissions Permissions Permission(s) required to run the code (for example, a mobile app may require full internet access or may run only on wifi). text 11 #VALUE FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/permissions
memoryRequirements Memory Requirements Minimum memory requirements. text 12 #VALUE FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/memoryRequirements
processorRequirements Processor Requirements Processor architecture required to run the application (e.g. IA64). text 13 #VALUE FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/processorRequirements
storageRequirements Storage Requirements Storage requirements (e.g. free space required). text 14 #VALUE FALSE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://schema.org/storageRequirements
releaseNotes Release Notes Link to release notes https://... url 15 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://schema.org/releaseNotes
contIntegration Continous integration Link to continuous integration service https://... url 16 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20
issueTracker Issue Tracker Link to software bug reporting or issue tracking system https://... url 17 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE TRUE FALSE FALSE codeMeta20
#controlledVocabulary DatasetField Value identifier displayOrder
developmentStatus Concept concept 0
developmentStatus WIP wip 1
developmentStatus Active active 2
developmentStatus Inactive inactive 3
developmentStatus Unsupported unsupported 4
developmentStatus Moved moved 5
developmentStatus Suspended suspended 6
developmentStatus Abandoned abandoned 7
1 change: 1 addition & 0 deletions scripts/api/setup-datasetfields.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @da
curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @data/metadatablocks/astrophysics.tsv -H "Content-type: text/tab-separated-values"
curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @data/metadatablocks/biomedical.tsv -H "Content-type: text/tab-separated-values"
curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @data/metadatablocks/journals.tsv -H "Content-type: text/tab-separated-values"
curl http://localhost:8080/api/admin/datasetfield/load -X POST --data-binary @data/metadatablocks/codemeta.tsv -H "Content-type: text/tab-separated-values"