NMstamp: stamp a dataset or any other object

View source: R/NMstamp.R

NMstampR Documentation

stamp a dataset or any other object

Description

Dataset metadata can be valuable, eg. by tracing an archived dataset back to the code that generated it. The metadata added by NMstamp can be accessed using the function NMinfo.

Usage

NMstamp(data, script, time = Sys.time(), ...)

Arguments

data

The dataset to stamp.

script

path to the script where the dataset was generated.

time

the time stamp to attach. Default is to use cpu clock.

...

other named metadata elements to add to the dataset. Example: Description="PK data for phase 1 trials in project".

Details

NMstamp modifies the meta data by reference. See example.

Value

data with meta data attached. Class unchanged.

See Also

NMinfo

Other DataCreate: NMorderColumns(), NMwriteData(), addTAPD(), findCovs(), findVars(), flagsAssign(), flagsCount(), mergeCheck(), tmpcol()

Examples

x=1
NMstamp(x,script="example.R",description="Example data")
NMinfo(x)

NMdata documentation built on Nov. 11, 2023, 5:07 p.m.