timeStampMrbin: A function for time stamping mrbin objects.

View source: R/mrbin.R

timeStampMrbinR Documentation

A function for time stamping mrbin objects.

Description

This function adds time stamps to an mrbin object and returns it. Is used only within functions making changes to mrbin objects.

Usage

timeStampMrbin(
  mrbinObject,
  functionName = "InProgress...",
  versionNumber = "0",
  changeDetails = "InProgress...",
  steps = 0,
  comment = ""
)

Arguments

mrbinObject

An mrbin object

functionName

Name of the package and function calling this command

versionNumber

Version number of the package calling this command

changeDetails

Details of changes made to the mrbin object

steps

Indicates which step to perform: 0 (only pre-change), 1 (only post-change)

comment

An optional character vector describing the change

Value

An (invisible) mrbin object

Examples

mrbinObject<-createmrbin()
mrbinObject<-timeStampMrbin(mrbinObject)

mrbin documentation built on Jan. 23, 2023, 5:41 p.m.