safe_people: Safe People details
In dsROCrate: 'DataSHIELD' RO-Crate Governance Functions

safe_people

R Documentation

Safe People details

Description

Safe People details for the RO-Crate.

Usage

safe_people(x, ...)

## S3 method for class 'ArmadilloCredentials'
safe_people(x, ...)

## S3 method for class 'character'
safe_people(
  x,
  ...,
  user = attr(x, "user"),
  user_id_suffix = "#person:",
  set_author = TRUE,
  set_project = TRUE,
  connection = attr(x, "connection"),
  path = attr(x, "path"),
  profile = attr(x, "profile"),
  project = attr(x, "project"),
  resources = attr(x, "resources"),
  tables = attr(x, "tables")
)

## S3 method for class 'opal'
safe_people(
  x,
  ...,
  rocrate = rocrateR::rocrate_5s(),
  user = NULL,
  user_id_suffix = "#person:",
  set_author = TRUE,
  set_project = TRUE,
  path = NULL,
  profile = "default",
  project = NULL,
  resources = NULL,
  tables = NULL
)

## S3 method for class 'rocrate'
safe_people(
  x,
  ...,
  user = attr(x, "user"),
  user_id_suffix = "#person:",
  set_author = TRUE,
  set_project = TRUE,
  connection = attr(x, "connection"),
  path = attr(x, "path"),
  profile = attr(x, "profile"),
  project = attr(x, "project"),
  resources = attr(x, "resources"),
  tables = attr(x, "tables")
)

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.
`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.
`user_id_suffix`	String with ID suffix for the people/user entities in the RO-Crate (default: `"#person:"`).
`set_author`	Boolean flag to indicate if the current user should be set as the author of the RO-Crate.
`set_project`	Boolean flag to indicate if any `Project` entities found in `x` should be linked to the Safe People entity.
`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.
`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.
`profile`	String with profile name.
`project`	String with the name of the Safe Project.
`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.
`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()`).