writeStatus {Mosaic}R Documentation

writeStatus

Description

Write or update a status dataframe with custom messages, time stamp and time elapsed since last status. Useful to document time consumed analysis by steps.

Usage

writeStatus(previous = NULL, message = list(Status = "Starting analysis",
  Details = "loading files"), wd = getwd())

Arguments

previous

a writeStatus object to be updated (must have same column names); new object generated if NULL.

message

named list of columns with custom messages

wd

directory where the status.csv file should be written and updated. If NULL, no status.csv is written.

Examples


status <- writeStatus(previous = NULL,
            message = list(Status = "Starting analysis",
                           Details = "loading files"
                          ),
           wd = getwd())
           
           
status <- writeStatus(previous = status,
            message = list(Status = "Running analysis",
                           Details = "detecting features"
                          ),
           wd = getwd())


[Package Mosaic version 0.7.2 Index]