Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
116 commits
Select commit Hold shift + click to select a range
c151a01
Update bag_rocrate.character to create normalised path for the `outpu…
villegar Nov 6, 2025
e872ef7
Update tests for unbag_rocrate to delete intermediate outputs between…
villegar Nov 6, 2025
11dcd8f
Add new internal function .get_zip_root to get the root directory of …
villegar Nov 6, 2025
367df8c
Append devlopment suffix to the Version attribute
villegar Nov 6, 2025
f2dc0b1
Update unbag_rocrate to handle bags containing hidden files (e.g., __…
villegar Mar 2, 2026
2489b21
Remove unused function, .get_zip_root
villegar Mar 2, 2026
1d22944
Update tests to account for changes to unbag_rocrate
villegar Mar 2, 2026
9fa15fd
Update .validate_bagit_declaration to be case insensitive, create int…
villegar Mar 2, 2026
94d9bdf
Update return object by is_rocrate_bag, now a boolean type
villegar Mar 3, 2026
4e20fb2
Update version and include additional authors
villegar Mar 3, 2026
0cf19c3
Update is_rocrate_bag to verify whether the input is a file path or d…
villegar Mar 3, 2026
e9ada64
Add function to load and validate RO-Crate bag, load_rocrate_bag
villegar Mar 3, 2026
f4deaab
Refactor internal function .validate_rocrate_bag to streamline checks…
villegar Mar 3, 2026
5e6e18e
Add internal function, .detect_manifest_algo, so the algo argument in…
villegar Mar 3, 2026
66e7b50
Update validation of BagIt manifest file
villegar Mar 3, 2026
e5c53d9
Add new internal function, .validate_json_syntax, that checks if an R…
villegar Mar 3, 2026
4631ef1
Refactor is_rocrate to streamline checks and leave scope for future s…
villegar Mar 3, 2026
690f3ff
Minor documentation changes and include semantic validation of rocrat…
villegar Mar 3, 2026
f7af5a1
Add new internal function to optionally verify the BagIt Payload Oxum
villegar Mar 3, 2026
773a208
Add new function to derive BagIt Payload Oxum
villegar Mar 3, 2026
bbde844
Add new internal function, bagit_info, to create a `bag-info.txt` fil…
villegar Mar 3, 2026
d692b21
Add high level function to load RO-Crates, load_rocrate. It can load …
villegar Mar 3, 2026
18d515b
Add new S3 generic method for print.rocrate_validation
villegar Mar 3, 2026
69f45f9
Remove redundant check
villegar Mar 3, 2026
83ec247
Break checks into various internal functions to avoid duplication of …
villegar Mar 3, 2026
4ec20ed
Add new internal function to create a RO-Crate validation object
villegar Mar 3, 2026
c6128ae
Add placeholder internal function to check JSON-LD compliance
villegar Mar 3, 2026
03252a3
Add new and update existing tests to capture new changes in the code
villegar Mar 3, 2026
fbaf514
New build
villegar Mar 3, 2026
f215371
Update get_entity to handle multi length `id` and `type`
villegar Mar 4, 2026
78a5eb6
Update .find_id_index and .find_type_index to use vapply, instead of …
villegar Mar 4, 2026
03dbd5e
Remove unused internal function
villegar Mar 4, 2026
e1c52f0
Remove strict (is_rocrate) validation from the load_rocrate_bag, erro…
villegar Mar 4, 2026
af74181
Migrate error checks to internal function .validate_rocrate and remov…
villegar Mar 4, 2026
9003307
Remove valid from the structure of new_rocrate_validation and dynamic…
villegar Mar 4, 2026
df5a038
Dynamically print the validity of rocrate
villegar Mar 4, 2026
fbf8a12
Fix bugs with creation of output directory for the bag_rocrate and wi…
villegar Mar 4, 2026
2b90ad5
Add internal functions to get root of RO-Crate and entity IDs
villegar Mar 4, 2026
86c545f
Add new function to validate RO-Crate validation based on profile
villegar Mar 4, 2026
b14c6f7
Add internal profile registry
villegar Mar 4, 2026
d901be9
Clean up code: ensure calls to stop & warning have call. = FALSE, cha…
villegar Mar 4, 2026
1a18e40
Add new optional arg to is_rocrate, to control if the function should…
villegar Mar 4, 2026
a13bad2
Add imports from base packages
villegar Mar 4, 2026
56e8f6e
Add examples
villegar Mar 4, 2026
cda2ea5
Simplify S3 method for print.rocrate
villegar Mar 4, 2026
767a7ac
Restructure code with air() and update setting class for new RO-Crate…
villegar Mar 4, 2026
4c34c45
Update internal documentation and replace utils::read.table with util…
villegar Mar 4, 2026
478f85f
Standardise extraction of elements from @graph
villegar Mar 4, 2026
c82844f
Remove importFrom and directly call utils::packageVersion
villegar Mar 4, 2026
30de1e5
Reuse the .get_entity_ids function
villegar Mar 4, 2026
6fd0ed9
New build
villegar Mar 4, 2026
285a53e
Update tests to include new changes
villegar Mar 4, 2026
e2af5fb
Rename internal functions to start with a dot
villegar Mar 5, 2026
0b72081
Add new function extract_content that writes to disk the `content` of…
villegar Mar 5, 2026
3aa7ad6
Add new create_dir argument to bag_rocrate, so the user can control i…
villegar Mar 5, 2026
fb79504
Add new function add_dataset to add a dataset to an RO-Crate object
villegar Mar 5, 2026
b6da330
Add new functions to add software application (add_software) and work…
villegar Mar 5, 2026
77cf589
Update calls to rocrateR::entity, so the @id argument is not named (x)
villegar Mar 5, 2026
f35cdae
Add higher level functions to add author (add_author), notebook (add_…
villegar Mar 5, 2026
64065aa
Simplify definition of rocrate(), to remove tibble requirement
villegar Mar 5, 2026
2b64faf
Add new check for the existence of the output directory when bagging …
villegar Mar 5, 2026
d66a635
Remove unused returned when validation entities and add tryCatch bloc…
villegar Mar 5, 2026
33fe738
Add new high level functions to add README (add_readme) and to create…
villegar Mar 5, 2026
b9334ac
Ignore build directory
villegar Mar 5, 2026
ed00c37
Update title, description and imports
villegar Mar 5, 2026
f5257b0
Refactor the entity module, so add_entity and remove_entity can take …
villegar Mar 6, 2026
89d77e6
Update add_entity_value to display more detailed error messages
villegar Mar 6, 2026
19b96cb
Minor styling changes
villegar Mar 6, 2026
190336c
Ensure that internal functions don't render documentation files, .Rd
villegar Mar 6, 2026
7f130b3
Introduce internal helper functions to reduce code duplication
villegar Mar 6, 2026
3879478
Ensure that entity @ids are parse to character values
villegar Mar 6, 2026
d61df9b
Remove unused importFrom
villegar Mar 6, 2026
d2b132e
Update examples
villegar Mar 6, 2026
bafaf2e
Update examples to capture changes in code
villegar Mar 6, 2026
be8ec3b
Import lifecycle to show deprecation warning
villegar Mar 6, 2026
ac3ca36
New build
villegar Mar 6, 2026
e96a536
Replace utils.delim by read.table
villegar Mar 6, 2026
c150c54
Add internal wrapper for file.copy, .copy_file
villegar Mar 8, 2026
3176d37
Update tests to address issues when testing on Windows
villegar Mar 8, 2026
f39508f
Add filter to crate_project, so it detects if path is missing and cha…
villegar Mar 8, 2026
c62c508
Remove additional args that are missing/NULL
villegar Mar 9, 2026
6edc1c0
Update warning message when no entities are found by get_entity
villegar Mar 11, 2026
df6a756
Update .find_type_index to handle entities with multiple types
villegar Mar 11, 2026
355716c
New build
villegar Mar 11, 2026
93c1eaa
Update tests to capture changes in add_dataset
villegar Mar 11, 2026
673aaa3
Deprecate read_rocrate in favour of load_rocrate. Add internal functi…
villegar Mar 30, 2026
2d31ed8
Update tests to handle depraction warning
villegar Mar 30, 2026
ee037d3
Deprecate load_rocrate_bag in favour of the unified load_rocrate. Not…
villegar Mar 30, 2026
d71b21d
Update tests to ignore deprecation warning for load_rocrate_bag
villegar Mar 30, 2026
ca71210
Update list of ignored files/dirs
villegar Mar 30, 2026
c699ef6
Split README into a vignette for getting started with rocrateR
villegar Mar 31, 2026
0c819d7
Update favicons
villegar Mar 31, 2026
dd44f47
Create manual template for pkgdown reference
villegar Mar 31, 2026
dad925f
Add new suggested packages and vignette builder
villegar Mar 31, 2026
ba9636e
Update print.rocrate generic to include an option for setting the max…
villegar Mar 31, 2026
593724d
New build
villegar Mar 31, 2026
baeb914
List changes for new release
villegar Mar 31, 2026
d796141
New build
villegar Mar 31, 2026
bd0cc1b
Update notation to avoid using pipe placeholder, _
villegar Mar 31, 2026
c57d73c
Update package's description
villegar Apr 1, 2026
3c2fe8c
Update list of ignore directories
villegar Apr 1, 2026
ffcfbd9
Update LICENSE year
villegar Apr 1, 2026
5e52165
Update list of non-standard words used in the package
villegar Apr 1, 2026
ed14cb5
Ignore LICENSE.md for builds
villegar Apr 1, 2026
810444a
Standardise @returns section for functions
villegar Apr 1, 2026
14e6293
Add summary.* generics for both entity and rocrate, additionally prin…
villegar Apr 1, 2026
fadb2c3
New build
villegar Apr 1, 2026
a29a882
Update call to filter to avoid using native pipe's placeholder
villegar Apr 1, 2026
057b455
Update vignette documentation
villegar Apr 1, 2026
215cd4a
Update call to filter to only keep File entities with missing content…
villegar Apr 1, 2026
cd2b424
Update version number to 0.1.0
villegar Apr 1, 2026
b817432
Remove build from list of ignore directories for builds
villegar Apr 1, 2026
c23b82f
Add missing references from pkgdown
villegar Apr 7, 2026
365e8fa
Ensure that all exported functions have a @returns tag
villegar Apr 7, 2026
4f4c142
New build
villegar Apr 7, 2026
d88a724
Increment version number to 0.1.0.9000
villegar Apr 9, 2026
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
7 changes: 6 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,14 @@
^cran-comments.md$
^README.Rmd$
^LICENSE.md$
^inst$
^inst/images$
^inst/R\.ignore$
^cran-comments\.md$
^_pkgdown\.yml$
^docs$
^pkgdown$
^CRAN-SUBMISSION$
^data-raw$
^doc$
^Meta$
^LICENSE\.md$
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,6 @@ docs
CRAN-SUBMISSION
cran-comments.md
*.html
inst/doc
/doc/
/Meta/
31 changes: 25 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,18 +1,36 @@
Package: rocrateR
Title: RO-Crate R Package Wrapper
Version: 0.0.1
Title: Tools for Creating and Manipulating RO-Crates
Version: 0.1.0.9000
Authors@R: c(
person(given = "Roberto",
family = "Villegas-Diaz",
role = c("aut", "cre"),
email = "r.villegas-diaz@outlook.com",
comment = c(ORCID = "0000-0001-5036-8661")),
person(given = "Rebecca",
family = "Wilson",
role = c("aut"),
comment = c(ORCID = "0000-0003-2294-593X")),
person(given = "Olly",
family = "Butters",
role = c("aut"),
comment = c(ORCID = "0000-0003-0354-8461")),
person(given = "Stuart",
family = "Wheater",
role = c("aut"),
comment = c(ORCID = "0009-0003-2419-1964")),
person("Research Object community", role = c("cph")))
Description: R package for creating, manipulating and reading RO-Crates. Latest
supported version of the specification: <https://w3id.org/ro/crate/1.2/>.
Description: Provides tools for creating, manipulating and reading Research
Object Crates (RO-Crates), a lightweight approach to packaging research
data with structured metadata. Includes utilities for metadata generation,
entity management, validation and reading existing RO-Crates following
the specification <https://w3id.org/ro/crate/1.2/>.
License: MIT + file LICENSE
Suggests:
spelling,
fs,
knitr,
rmarkdown,
spelling,
testthat (>= 3.0.0)
Config/testthat/edition: 3
Encoding: UTF-8
Expand All @@ -24,7 +42,8 @@ RoxygenNote: 7.3.3
Imports:
digest,
jsonlite,
tibble,
lifecycle,
zip
Depends:
R (>= 4.1.0)
VignetteBuilder: knitr
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
YEAR: 2025
YEAR: 2026
COPYRIGHT HOLDER: Research Object community
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MIT License

Copyright (c) 2025 Research Object community
Copyright (c) 2026 Research Object community

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
20 changes: 19 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,39 @@

S3method(bag_rocrate,character)
S3method(bag_rocrate,rocrate)
S3method(entity,default)
S3method(load_rocrate,character)
S3method(load_rocrate,rocrate)
S3method(print,entity)
S3method(print,rocrate)
S3method(print,rocrate_validation)
S3method(print,summary.entity)
S3method(print,summary.rocrate)
S3method(summary,entity)
S3method(summary,rocrate)
export(add_author)
export(add_dataset)
export(add_entities)
export(add_entity)
export(add_entity_value)
export(add_notebook)
export(add_project)
export(add_readme)
export(add_software)
export(add_workflow)
export(bag_rocrate)
export(crate_project)
export(entity)
export(extract_content)
export(get_entity)
export(is_rocrate)
export(is_rocrate_bag)
export(load_rocrate)
export(load_rocrate_bag)
export(read_rocrate)
export(remove_entities)
export(remove_entity)
export(rocrate)
export(rocrate_5s)
export(unbag_rocrate)
export(validate_rocrate)
export(write_rocrate)
25 changes: 25 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,28 @@
# rocrateR (development version)

# 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., `__MACOSX` on macOS).
* Refactored functions to streamline checks, including `is_rocrate`.
* Updated `get_entity` so it takes a vector for `id` and `type`, reuses the
shorter vector (only if the length 1), or errors if vectors have different
lengths.
* Updated `is_rocrate_bag` so 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_rocrate` to return the path to RO-Crate root _visibly_.
* `add_entities()` is deprecated. Use `add_entity()` instead.
* `load_rocrate_bag()` is deprecated. Use `load_rocrate()` instead. Note that
validation must be done as a separate step using `validate_rocrate()`.
* `read_rocrate()` is deprecated. Use `load_rocrate()` instead.
* `remove_entities()` is deprecated. Use `remove_entity()` instead.
* `entity(x=)` renamed to `entity(id=)`.

# rocrateR 0.0.1

* Initial CRAN submission.
Loading
Loading