edu.kit.datamanager
Java library to create and modify RO-Crates.
Science Score: 52.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
✓Institutional organization owner
Organization kit-data-manager has institutional domain (www.scc.kit.edu) -
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.8%) to scientific vocabulary
Keywords
file-based
folder-structure
library
linked-data
package-format
research-object
ro-crate
Last synced: 6 months ago
·
JSON representation
·
Repository
Java library to create and modify RO-Crates.
Basic Info
- Host: GitHub
- Owner: kit-data-manager
- License: apache-2.0
- Language: Java
- Default Branch: main
- Homepage: https://kit-data-manager.github.io/webpage/ro-crate-java/
- Size: 1.3 MB
Statistics
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 11
- Releases: 22
Topics
file-based
folder-structure
library
linked-data
package-format
research-object
ro-crate
Created almost 4 years ago
· Last pushed 7 months ago
Metadata Files
Readme
License
Citation
README.md
ro-crate-java
A Java library to create and modify RO-Crates. The aim of this implementation is to not require too deep knowledge of the specification, and avoiding crates which do not fully comply to the specification, at the same time.
Use it in your application
- Instructions for your build manager (e.g., Gradle, Maven, etc.)
- Quick-Start
- JavaDoc Documentation
- Related Publications
Build the library / documentation
- Building (with tests):
./gradlew clean build - Building (without tests):
./gradlew clean build -x test - Building with release profile:
./gradlew -Dprofile=release clean build - Doing a release:
./gradlew -Dprofile=release clean build release- Will prompt you about version number to use and next version number
- Will make a git tag which can later be used in a GitHub release
- A GitHub release will trigger the CI for publication. See also
.github/workflows/publishRelease.yml.
- Build documentation:
./gradlew javadoc
On Windows, replace ./gradlew with gradlew.bat.
RO-Crate Specification Compatibility
- ✅ Version 1.1 (Extracted examples as well-described unit tests/guide)
- 🛠️ Version 1.2-DRAFT
- ✅ Reading and writing crates with additional profiles or specifications (examples for reading, examples for writing)
- ✅ Adding profiles or other specifications to a crate (examples)
Quick-start
ro-crate-java makes use of the builder pattern to guide the user to create a valid RO-Crate, similar to:
java
RoCrate myFirstCrate = STARTER_CRATE
.addDataEntity(
new FileEntity.FileEntityBuilder()
.setId("path/within/crate/survey-responses-2019.csv")
.setLocation(Paths.get("path/to/current/location/experiment.csv"))
.addProperty("name", "Survey responses")
.addProperty("contentSize", "26452")
.addProperty("encodingFormat", "text/csv")
.build()
)
.addDataEntity(/*...*/)
.addContextualEntity(/*...*/)
.build();
A built or imported crate can of course also be modified afterwards. Take a look at our further documentation:
- There is a well-documented example-driven guide in LearnByExampleTest.java to help you get started.
- You may also be interested in the examples we extracted from the specification in version 1.1, which are available in ExamplesOfSpecificationV1p1Test.java.
- There is a module with all well-described guiding tests available.
- The JavaDoc Documentation is also available online.
Owner
- Name: KIT Data Manager
- Login: kit-data-manager
- Kind: organization
- Email: webmaster@datamanger.kit.edu
- Location: Karlsruhe, Germany
- Website: https://www.scc.kit.edu/ueberuns/dem.php
- Repositories: 56
- Profile: https://github.com/kit-data-manager
Generic software and recommendations for FAIR research data management by DEM.
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Tzochev" given-names: "Nikola" - family-names: "Pfeil" given-names: "Andreas" orcid: "https://orcid.org/0000-0001-6575-1022" - family-names: "Chelbi" given-names: "Sabrine" orcid: "https://orcid.org/0000-0002-4480-6116" title: "ro-crate-java" version: 2.1.0-rc3 date-released: 2025-06-06 url: "https://github.com/kit-data-manager/ro-crate-java"
GitHub Events
Total
- Create event: 68
- Issues event: 17
- Release event: 5
- Watch event: 2
- Delete event: 50
- Issue comment event: 127
- Push event: 160
- Pull request review comment event: 87
- Pull request event: 127
- Pull request review event: 71
- Fork event: 2
Last Year
- Create event: 68
- Issues event: 17
- Release event: 5
- Watch event: 2
- Delete event: 50
- Issue comment event: 127
- Push event: 160
- Pull request review comment event: 87
- Pull request event: 127
- Pull request review event: 71
- Fork event: 2
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 36
- Total pull requests: 247
- Average time to close issues: 10 months
- Average time to close pull requests: 17 days
- Total issue authors: 7
- Total pull request authors: 8
- Average comments per issue: 1.44
- Average comments per pull request: 0.81
- Merged pull requests: 185
- Bot issues: 0
- Bot pull requests: 191
Past Year
- Issues: 17
- Pull requests: 105
- Average time to close issues: 8 days
- Average time to close pull requests: 9 days
- Issue authors: 4
- Pull request authors: 5
- Average comments per issue: 0.41
- Average comments per pull request: 1.09
- Merged pull requests: 76
- Bot issues: 0
- Bot pull requests: 76
Top Authors
Issue Authors
- Pfeil (19)
- Code42Cate (8)
- ThomasJejkal (3)
- AndreasMeier12 (2)
- fpotier (2)
- StuartWheater (1)
- beepsoft (1)
- sabrineChe (1)
- dependabot[bot] (1)
Pull Request Authors
- dependabot[bot] (170)
- renovate[bot] (74)
- Pfeil (45)
- Code42Cate (6)
- sabrineChe (6)
- fpotier (4)
- craquet (2)
- ThomasJejkal (2)
Top Labels
Issue Labels
enhancement (12)
good first issue (7)
specification-compliance (6)
maintenance (4)
bug (4)
documentation (4)
DRAFT-feature (3)
invalid (3)
question (2)
code quality (2)
breaking (2)
dependencies (1)
java (1)
Pull Request Labels
dependencies (244)
java (140)
github_actions (15)
enhancement (4)
code quality (3)
bug (3)
specification-compliance (1)
Packages
- Total packages: 1
- Total downloads: unknown
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 18
repo1.maven.org: edu.kit.datamanager:ro-crate-java
A library for easy creation and modification of valid RO-Crates.
- Homepage: https://github.com/kit-data-manager/ro-crate-java
- Documentation: https://appdoc.app/artifact/edu.kit.datamanager/ro-crate-java/
- License: The Apache License, Version 2.0
-
Latest release: 2.0.2
published 11 months ago
Rankings
Dependent repos count: 20.7%
Average: 44.6%
Dependent packages count: 50.1%
Forks count: 52.5%
Stargazers count: 55.1%
Last synced:
7 months ago
Dependencies
build.gradle
maven
- com.fasterxml.jackson.core:jackson-databind 2.13.2.2 implementation
- com.fasterxml.jackson.datatype:jackson-datatype-jsr310 2.13.2 implementation
- com.github.fslev:json-compare 2.42 implementation
- org.glassfish:jakarta.json 2.0.1 implementation
- org.junit.jupiter:junit-jupiter-api 5.8.2 testImplementation
- org.junit.jupiter:junit-jupiter-engine 5.8.2 testRuntimeOnly
.github/workflows/codeql-analysis.yml
actions
- actions/checkout v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
.github/workflows/gradle.yml
actions
- actions/checkout v3 composite
- actions/setup-java v3 composite
- gradle/gradle-build-action v2 composite
- gradle/wrapper-validation-action v1 composite
.github/workflows/publishRelease.yml
actions
- actions/checkout v3 composite
- actions/setup-java v3 composite