Releases: ResearchObject/ro-crate-r
Releases · ResearchObject/ro-crate-r
rocrateR 0.1.0
- Added higher level function to load RO-Crates from various inputs,
load_rocrate. - Added higher level function to validate RO-Crate and display report with
errors and warnings (if any was found),validate_rocrate. - Defined new checks for RO-Crate validation to ignore system specific
directories (e.g.,__MACOSXon macOS). - Refactored functions to streamline checks, including
is_rocrate. - Updated
get_entityso it takes a vector foridandtype, reuses the
shorter vector (only if the length 1), or errors if vectors have different
lengths. - Updated
is_rocrate_bagso it returns a boolean value, indicating the
validity of the given RO-Crate bag. Previously, it returned a path to the
root of the RO-Crate. - Updated
unbag_rocrateto return the path to RO-Crate root visibly. add_entities()is deprecated. Useadd_entity()instead.load_rocrate_bag()is deprecated. Useload_rocrate()instead. Note that
validation must be done as a separate step usingvalidate_rocrate().read_rocrate()is deprecated. Useload_rocrate()instead.remove_entities()is deprecated. Useremove_entity()instead.entity(x=)renamed toentity(id=).
rocrateR 0.0.1
This is the first CRAN release, the package includes functions for the creation and manipulation of RO-Crates, including the use of the 5s-create profile. Additionally, there are functions to validate the format of the RO-Crates (and their entities), as well as to create & validate RO-Crate bags with BagIt.
Here's a summary of the main functions in this version of the package:
| Function | Purpose |
|---|---|
rocrate() |
Create an empty or initialised RO-Crate |
entity() |
Define a new entity (Person, Dataset, etc.) |
add_entity() / add_entities() |
Add entities to a crate |
get_entity() |
Retrieve entities by @id or @type |
remove_entity() / remove_entities() |
Remove one or more entities |
write_rocrate() |
Save RO-Crate to disk |
bag_rocrate() / is_rocrate_bag() / unbag_rocrate() |
Bagging and unbagging RO-Crates |
Acknowledgements
This work was carried out as part of the FOCUS-5 project - DARE UK Phase 2 Programme, funded by HDR UK.