safe_project: Safe Project details
In dsROCrate: 'DataSHIELD' RO-Crate Governance Functions

safe_project

R Documentation

Safe Project details

Description

Safe Project details for the RO-Crate.

Usage

safe_project(x, ...)

## S3 method for class 'ArmadilloCredentials'
safe_project(
  x,
  ...,
  profile = "default",
  project = NULL,
  rocrate = rocrateR::rocrate_5s(),
  asset_id_suffix = "#asset:",
  project_id_suffix = "#project:",
  path = NULL,
  resources = NULL,
  tables = NULL,
  user = NULL
)

## S3 method for class 'character'
safe_project(
  x,
  ...,
  profile = attr(x, "profile"),
  project = attr(x, "project"),
  asset_id_suffix = "#asset:",
  project_id_suffix = "#project:",
  connection = attr(x, "connection"),
  path = attr(x, "path"),
  resources = attr(x, "resources"),
  tables = attr(x, "tables"),
  user = attr(x, "user")
)

## S3 method for class 'opal'
safe_project(
  x,
  ...,
  profile = "default",
  project = NULL,
  rocrate = rocrateR::rocrate_5s(),
  asset_id_suffix = "#asset:",
  project_id_suffix = "#project:",
  path = NULL,
  resources = NULL,
  tables = NULL,
  user = NULL
)

## S3 method for class 'rocrate'
safe_project(
  x,
  ...,
  profile = attr(x, "profile"),
  project = attr(x, "project"),
  asset_id_suffix = "#asset:",
  project_id_suffix = "#project:",
  connection = attr(x, "connection"),
  path = attr(x, "path"),
  resources = attr(x, "resources"),
  tables = attr(x, "tables"),
  user = attr(x, "user")
)

Arguments

`x`	This can be a connection to a 'DataSHIELD' server (e.g., object with the `opal` or `ArmadilloCredentials` classes), an RO-Crate (rocrate class) or a string with the path to an RO-Crate.
`...`	Further arguments passed on to the methods, which are documented as separate arguments below.
`profile`	String with profile name.
`project`	String with the name of the Safe Project.
`rocrate`	RO-Crate object. Optional, if `x` is either an RO-Crate object or a path to a valid RO-Crate. If so, then `connection` is required (default: `rocrateR::rocrate_5s()`).
`asset_id_suffix`	String with ID suffix for the tables/datasets entities in the RO-Crate (default: `"#asset:"`).
`project_id_suffix`	String with ID suffix for the project entities in the RO-Crate (default: `"#project:"`).
`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.
`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`	List (or entity object) with details for the Safe People, it must include `⁠@id⁠` and `name` entries. Alternatively, this can be a string with the `name` of the current user.
`connection`	Connection object for the 'DataSHIELD' server where the values will be extracted from (e.g., OBiBa's Opal). Optional, if `x` is set to a connection object. If so, then `rocrate` is required.

Details

Data must be used ethically, for research that delivers clear public benefit.

As part of their application, researchers are asked to provide an overview of their project, including how the data will be used and what outputs will be achieved. This allows data providers to make an informed decision about whether they are comfortable preparing data for the researcher to use for ethical purposes serving a public good.