writeStatus: writeStatus provides a text file featuring system and OS...

View source: R/writeStatus.R

writeStatusR Documentation

writeStatus provides a text file featuring system and OS information for documentation purposes.

Description

writeStatus provides a text file featuring system and OS information for documentation purposes.

Usage

writeStatus(pcAuxData, outName, what)

Arguments

pcAuxData

A fitted object of class PcAuxData produced as output of prepData, createPcAux, or miWithPcAux functions.

outName

A character vector indicating the name of the file to write the information to, such as a .txt file.

what

A character vector indicating the name of a function for which to extract status information. abbreviates the functions prepData, createPcAux, and miWithPcAux as "prep", "create", and "mi", respectively.

Value

A string object containing the compiled system and OS information.


dsquire/PcAux documentation built on May 2, 2024, 4:48 a.m.