datasetjson (version 0.2.0)

set_source_system: File Metadata Setters

Description

Set information about the file and source system used to generate the Dataset JSON object.

Usage

set_source_system(x, sys, sys_version)
set_originator(x, originator)
set_file_oid(x, file_oid)
set_data_type(x, data_type = c("clinicalData", "referenceData"))

Value

datasetjson or file_metadata object

Arguments

x

datasetjson object

sys

sourceSystem parameter, defined as "The computer system or database management system that is the source of the information in this file."

sys_version

sourceSystemVersion, defined as "The version of the sourceSystem"

originator

originator parameter, defined as "The organization that generated the Dataset-JSON file."

file_oid

fileOID parameter, defined as "A unique identifier for this file."

data_type

Type of data being written. clinicalData for subject level data, and referenceData for non-subject level data (i.e. TDMs, Associated Persons)

Details

The fileOID parameter should be structured following description outlined in the ODM V2.0 specification. "FileOIDs should be universally unique if at all possible. One way to ensure this is to prefix every FileOID with an internet domain name owned by the creator of the ODM file or database (followed by a forward slash, "/"). For example, FileOID="BestPharmaceuticals.com/Study5894/1" might be a good way to denote the first file in a series for study 5894 from Best Pharmaceuticals."

Examples

file_meta <- file_metadata()

file_meta_updated <- set_file_oid(file_meta, "/some/path")
file_meta_updated <- set_originator(file_meta_updated, "Some Org")
file_meta_updated <- set_source_system(file_meta_updated, "source system", "1.0")