CRAN release candidate

.Rbuildignore

@@ -4,4 +4,10 @@
 ^codecov.yml$
 ^cran-comments.md$
 ^README.Rmd$
-^LICENSE.md$
+^LICENSE.md$
+^inst$
+^cran-comments\.md$
+^_pkgdown\.yml$
+^docs$
+^pkgdown$
+^CRAN-SUBMISSION$

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,16 @@
+---
+name: Bug report or feature request
+about: Describe a bug you've seen or make a case for a new feature
+---
+
+Please briefly describe your problem and what output you expect. If you have a question, please don't use this form. Instead, ask on <https://stackoverflow.com/> or <https://community.rstudio.com/>.
+
+Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
+
+For more advice on how to write a great issue, see <https://code-review.tidyverse.org/issues/>.
+
+Brief description of the problem
+
+```r
+# insert reprex here
+```

.github/workflows/rhub.yaml

@@ -0,0 +1,95 @@
+# R-hub's generic GitHub Actions workflow file. It's canonical location is at
+# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml
+# You can update this file to a newer version using the rhub2 package:
+#
+# rhub::rhub_setup()
+#
+# It is unlikely that you need to modify this file manually.
+
+name: R-hub
+run-name: "${{ github.event.inputs.id }}: ${{ github.event.inputs.name || format('Manually run by {0}', github.triggering_actor) }}"
+
+on:
+  workflow_dispatch:
+    inputs:
+      config:
+        description: 'A comma separated list of R-hub platforms to use.'
+        type: string
+        default: 'linux,windows,macos'
+      name:
+        description: 'Run name. You can leave this empty now.'
+        type: string
+      id:
+        description: 'Unique ID. You can leave this empty now.'
+        type: string
+
+jobs:
+
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      containers: ${{ steps.rhub-setup.outputs.containers }}
+      platforms: ${{ steps.rhub-setup.outputs.platforms }}
+
+    steps:
+    # NO NEED TO CHECKOUT HERE
+    - uses: r-hub/actions/setup@v1
+      with:
+        config: ${{ github.event.inputs.config }}
+      id: rhub-setup
+
+  linux-containers:
+    needs: setup
+    if: ${{ needs.setup.outputs.containers != '[]' }}
+    runs-on: ubuntu-latest
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.containers) }}
+    container:
+      image: ${{ matrix.config.container }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+
+  other-platforms:
+    needs: setup
+    if: ${{ needs.setup.outputs.platforms != '[]' }}
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.platforms) }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/setup-r@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}

.gitignore

@@ -1,50 +1,42 @@
 # History files
 .Rhistory
 .Rapp.history
-
 # Session Data files
 .RData
 .RDataTmp
-
 # User-specific files
 .Ruserdata
-
 # Example code in package build process
 *-Ex.R
-
 # Output files from R CMD build
 /*.tar.gz
-
 # Output files from R CMD check
 /*.Rcheck/
-
 # RStudio files
 .Rproj.user/
-
 # produced vignettes
 vignettes/*.html
 vignettes/*.pdf
-
 # OAuth2 token, see https://github.com/hadley/httr/releases/tag/v0.3
 .httr-oauth
-
 # knitr and R markdown default cache directories
 *_cache/
 /cache/
-
 # Temporary files created by R markdown
 *.utf8.md
 *.knit.md
-
 # R Environment Variables
 .Renviron
-
 # pkgdown site
 docs/
-
 # translation temp files
 po/*~
-
 # RStudio Connect folder
 rsconnect/
 .Rproj.user
+*.Rproj
+.DS_Store
+docs
+CRAN-SUBMISSION
+cran-comments.md
+*.html

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rocrateR
 Title: RO-Crate R Package Wrapper
-Version: 0.0.1.9000
+Version: 0.0.1
 Authors@R: c(
     person(given = "Roberto",
            family = "Villegas-Diaz",
@@ -9,15 +9,22 @@ Authors@R: c(
            comment = c(ORCID = "0000-0001-5036-8661")),
     person("Research Object community", role = c("cph")))
 Description: R package for creating, manipulating and reading RO-Crates. Latest
-    supported version  1.2 of the specification. 
+    supported version of the specification: <https://w3id.org/ro/crate/1.2/>.
 License: MIT + file LICENSE
-Suggests: 
+Suggests:
+    spelling, 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Encoding: UTF-8
 Language: en-GB
+URL: https://github.com/ResearchObject/ro-crate-r/
+BugReports: https://github.com/ResearchObject/ro-crate-r/issues/
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
+RoxygenNote: 7.3.3
 Imports: 
+    digest,
     jsonlite,
-    tibble
+    tibble,
+    zip
+Depends: 
+    R (>= 4.1.0)

NAMESPACE

@@ -1,13 +1,22 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(bag_rocrate,character)
+S3method(bag_rocrate,rocrate)
 S3method(entity,default)
+S3method(print,entity)
 S3method(print,rocrate)
+export(add_entities)
 export(add_entity)
 export(add_entity_value)
+export(bag_rocrate)
 export(entity)
+export(get_entity)
 export(is_rocrate)
+export(is_rocrate_bag)
 export(read_rocrate)
+export(remove_entities)
 export(remove_entity)
 export(rocrate)
 export(rocrate_5s)
+export(unbag_rocrate)
 export(write_rocrate)

NEWS.md

@@ -0,0 +1,3 @@
+# rocrateR 0.0.1
+
+* Initial CRAN submission.