Package: dsROCrate 0.1.0

Roberto Villegas-Diaz

dsROCrate: 'DataSHIELD' RO-Crate Governance Functions

Tools for wrapping 'DataSHIELD' analyses into RO-Crate (Research Object Crate) objects. Provides functions to create structured metadata for federated data analysis projects, enabling governance tracking of data access, project membership, analysis execution and output validation across distributed data sources.

Authors:Roberto Villegas-Diaz [aut, cre], Becca Wilson [aut], Olly Butters [aut], Stuart Wheater [aut], University of Liverpool [cph]

dsROCrate_0.1.0.tar.gz
dsROCrate_0.1.0.zip(r-4.7)dsROCrate_0.1.0.zip(r-4.6)dsROCrate_0.1.0.zip(r-4.5)
dsROCrate_0.1.0.tgz(r-4.6-any)dsROCrate_0.1.0.tgz(r-4.5-any)
dsROCrate_0.1.0.tar.gz(r-4.7-any)dsROCrate_0.1.0.tar.gz(r-4.6-any)
dsROCrate_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
dsROCrate/json (API)

# Install 'dsROCrate' in R:
install.packages('dsROCrate', repos = c('https://federatedmethods.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/federatedmethods/dsrocrate/issues

On CRAN:

Conda:

5.54 score 3 scripts 489 downloads 10 exports 96 dependencies

Last updated from:5c16bf7479. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK167
source / vignettesOK311
linux-release-x86_64OK162
macos-release-arm64OK114
macos-oldrel-arm64OK85
windows-develOK109
windows-releaseOK94
windows-oldrelOK117
wasm-releaseOK159

Exports:armadillo_loginauditcheck_permissionsinitreportsafe_datasafe_outputsafe_peoplesafe_projectsafe_setting

Dependencies:askpassassertthatbase64encbitbit64bslibcachemclicliprcommonmarkcpp11crayoncurlDiagrammeRDiagrammeRsvgdigestdplyrDSIDSMolgenisArmadilloevaluatefarverfastmapfontawesomeforcatsfsgenericsgluehavenhighrhmshtmltoolshtmlwidgetshttpuvhttrhttr2igraphjquerylibjsonliteknitrlabelinglabelledlaterlatticelifecyclemagrittrMatrixmemoisemimeMolgenisAuthopalropensslotelpillarpkgconfigprettyunitsprogresspromisespurrrR6rappdirsRColorBrewerRcppRcppTOMLreadrrlangrmarkdownrocrateRrstudioapirsvgsassscalesshinysourcetoolsstringistringrsystibbletidyrtidyselecttinytextriebeardtzdburltoolsutf8V8vctrsviridisLitevisNetworkvroomvtreewithrxfunxptrxtableyamlzip

Configuring Audit Permissions
Overview | Why are elevated permissions required? | Supported backends | Opal | Required permissions | Configuring an Opal audit user | Step 1: Log in as an administrator | Step 2: Create a user (optional) | Step 3: Grant audit permissions | Example usage | Troubleshooting | Insufficient permissions | Testing Opal permissions directly
Rendered fromaudit-permissions.Rmdusingknitr::rmarkdown

Last update: 2026-06-01
Started: 2026-06-01

Deploy a local DataSHIELD server with Opal
What is Opal? | Deploy Docker containers | Setup | Open connection | Test deployment
Rendered fromdeploy-local-datashield-server-with-opal.Rmdusingknitr::rmarkdown

Last update: 2026-06-01
Started: 2025-10-29

Getting Started
1. Creating your first RO-Crate | 1.1. Connect to an Opal server | Open connection | 1.2. Create a basic RO-Crate | 1.3. Add the Five Safes Elements | Safe Data | Safe Project | Safe People | Safe Setting | Safe Outputs | DataSHIELD operations | Setup | Simulate some operations | 1.4. Close connection | 1.5. Bag/Save RO-Crate | 1.6. Clean working directory | 2. Auditing RO-Crates and servers | 2.1. Audit People | List accessible tables within a project for an user | Markdown report | 2.2. Audit Project | List users and dataset/table level permissions within a project | 2.3. Audit Study | List users and dataset/table level permissions within a study (i.e., multiple servers)
Rendered fromgetting-started.Rmdusingknitr::rmarkdown

Last update: 2026-06-01
Started: 2026-04-17

Readme and manuals

Help Manual

Help pageTopics
Login to a MOLGENIS' Armadillo serverarmadillo_login
Create an audit RO-Crateaudit audit.ArmadilloCredentials audit.character audit.cr8tor audit.list audit.opal audit.rocrate
Check backend connection permissionscheck_permissions
Initialise a Five Safes RO-Crateinit init.opal init.rocrate
Create an RO-Crate reportreport report.character report.default report.list report.rocrate
Safe Data detailssafe_data safe_data.character safe_data.opal safe_data.rocrate
Safe Output detailssafe_output safe_output.character safe_output.opal safe_output.rocrate
Safe People detailssafe_people safe_people.character safe_people.opal safe_people.rocrate
Safe Project detailssafe_project safe_project,armadillo-method safe_project.ArmadilloCredentials safe_project.character safe_project.opal safe_project.rocrate
Safe Setting detailssafe_setting safe_setting.character safe_setting.cr8tor safe_setting.opal safe_setting.rocrate