Merge pull request #8 from ResearchObject/dev

CRAN v0.1.0: Enhance RO-Crate handling and validation functions

Author: villegar

.Rbuildignore

@@ -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$

.gitignore

@@ -40,3 +40,6 @@ docs
 CRAN-SUBMISSION
 cran-comments.md
 *.html
+inst/doc
+/doc/
+/Meta/

DESCRIPTION

@@ -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
@@ -24,7 +42,8 @@ RoxygenNote: 7.3.3
 Imports: 
     digest,
     jsonlite,
-    tibble,
+    lifecycle,
     zip
 Depends: 
     R (>= 4.1.0)
+VignetteBuilder: knitr

LICENSE

@@ -1,2 +1,2 @@
-YEAR: 2025
+YEAR: 2026
 COPYRIGHT HOLDER: Research Object community

LICENSE.md

@@ -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

NAMESPACE

@@ -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)

NEWS.md

@@ -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.