audit: Create an audit RO-Crate

In dsROCrate: 'DataSHIELD' RO-Crate Governance Functions

Create an audit RO-Crate

Description

Create an audit RO-Crate from a server connection. If given an RO-Crate, it is returned unchanged.

Usage

audit(x, ...)

## S3 method for class 'ArmadilloCredentials'
audit(x, ..., intent = NULL)

## S3 method for class 'character'
audit(x, ..., intent = NULL)

## S3 method for class 'cr8tor'
audit(x, ..., intent = NULL)

## S3 method for class 'list'
audit(x, ..., intent = NULL)

## S3 method for class 'opal'
audit(
  x,
  ...,
  intent = NULL,
  profile = "default",
  project = NULL,
  resources = NULL,
  tables = NULL,
  user = NULL,
  logs_from = -Inf,
  logs_to = Inf,
  path = NULL
)

## S3 method for class 'rocrate'
audit(x, ..., intent = NULL)

Arguments

x	Object to be audited. This can be a connection to a DataSHIELD server (e.g., OBiBa's Opal). a path pointing to an RO-Crate OR a cr8tor archive / governance bundle. an RO-Crate object. If so, returns the input object. Alternatively, a list of any of the above.
...	Additional arguments.
intent	Additional object with governance bundle/specification of the intent of a project. It takes the same types as x.
profile	String with profile name.
project	String with project name(s) from which to extract Safe Project details.
resources	Vector of strings with the names of the resources, part of project. Optional, if not provided, all the resources associated to project will be included in the RO-Crate.
tables	Vector of strings with the names of the tables/datasets, part of project. Optional, if not provided, all the tables/datasets associated to project will be included in the RO-Crate.
user	String with the user name for which to extract Safe People details.
logs_from	Lower limit timestamp to filter out the outputs generated (default: -Inf, everything up to logs_to)
logs_to	Upper limit timestamp to filter out the outputs generated (default: Inf, everything from logs_from onwards).
path	String with path pointing to the root of the RO-Crate. This will be used to store log files. If not provided, logs will be stored within the RO-Crate returned by this function.

Details

This function handles various audit types, which will be dispatched based on the input object. If the input object is

• a connection to a DataSHIELD server (e.g., OBiBa's Opal): generates an RO-Crate object with deployment details, including outputs.

• a path pointing to

  • a cr8tor archive / governance bundle: generates an RO-Crate object with pre-deployment governance details.

  • an RO-Crate object: generates an RO-Crate object with clearly defined 5 Safes elements.

• an RO-Crate object: generates an RO-Crate object with clearly defined 5 Safes elements.

Value

RO-Crate with audit details.

dsROCrate documentation built on Oct. 16, 2026, 5:09 p.m.