MSstatsLogsSettings: Set how MSstats will log information from data processing

Description Usage Arguments Value Examples

View source: R/utils_logging.R

Description

Set how MSstats will log information from data processing

Usage

1
2
3
4
5
6
7
MSstatsLogsSettings(
  use_log_file = TRUE,
  append = FALSE,
  verbose = TRUE,
  log_file_path = NULL,
  base = "MSstats_log_"
)

Arguments

use_log_file

logical. If TRUE, information about data processing will be saved to a file.

append

logical. If TRUE, information about data processing will be added to an existing log file.

verbose

logical. If TRUE, information about data processing wil be printed to the console.

log_file_path

character. Path to a file to which information about data processing will be saved. If not provided, such a file will be created automatically. If append = TRUE, has to be a valid path to a file.

base

start of the file name.

Value

TRUE invisibly in case of successful logging setup.

Examples

1
2
3
4
5
6
7
8
9
# No logging and no messages
MSstatsLogsSettings(FALSE, FALSE, FALSE)
# Log, but do not display messages
MSstatsLogsSettings(TRUE, FALSE, FALSE)
# Log to an existing file
file.create("new_log.log")
MSstatsLogsSettings(TRUE, TRUE, log_file_path = "new_log.log")
# Do not log, but display messages
MSstatsLogsSettings(FALSE)

MSstatsConvert documentation built on Nov. 8, 2020, 5:49 p.m.