setEctdVerbose: MSToolkit package options

In MikeKSmith/MSToolkit: The MSToolkit Library For Clinical Trial Design

MSToolkit package options

Description

Options used by the MSToolkit package to control the logfile, the amount of messages that are written in the logfile, and the format of the date.

Usage

setEctdVerbose(verbose)

Arguments

verbose

(Required) A logical value. If set to TRUE, messages are sent to the logfile during the process of generating the data and analyzing it. Set to TRUE when attaching the package.

Details

The three function write and read information from the (not exported) environment .ectdEnv. These settings are mainly used by the (not exported) .log function.

Value

The function (invisibly) returns the previous value of the arguments.

See Also

options provides a similar mechanism for R options.

Examples

## Not run: 
  oldverb <- setEctdVerbose( TRUE )
  olddf   <- setEctdDateFormat("%Y")
  oldlf   <- setEctdLogFile("mstoolkit.log")

  for( i in 1:100 ) {
    MSToolkit:::.log( paste("some message:", i) )
  }
  file.show( getEctdLogFile() )

  setEctdVerbose   (oldverb)
  setEctdDateFormat(olddf  )
  setEctdLogFile   (oldlf  )


## End(Not run)

MikeKSmith/MSToolkit documentation built on Feb. 15, 2024, 5:32 p.m.