print_message: Print a message

In sen2r: Find, Download and Process Sentinel-2 Data

Print a message

Description

A common interface for printing messages of several types.

Usage

print_message(
  ...,
  type,
  sep = "",
  date = FALSE,
  date_format = "",
  width = 0.9 * getOption("width"),
  indent = TRUE,
  exdent = TRUE,
  prefix = "",
  initial = prefix
)

Arguments

...	R objects which are concatenated.
type	Type of the output .Accepted values: 'message' for a diagnostic message; 'string' for a character output; 'cat' for the output of cat() function; 'error' and 'warning' for an error or warning message. Intentionally, no default value is defined.
sep	(optional) character used to separate input values (default is nothing).
date	Logical value: set TRUE to place the date before the message and after the prefix (this is useful for logs or time consuming operations); default is FALSE.
date_format	Format of the date (see strftime()) for the definition of the format). The default format is '\%Y-\%m-\%d \%H:\%M:\%S'.
width	Positive integer: target column for wrapping lines in the output (set to Inf for no wrapping).
indent	Non-negative integer: indentation of the first line in a paragraph It can be also a logical: in this case, if TRUE (default) the value is optimised in order to align first line with the followings.
exdent	Non-negative integer: indentation of subsequent lines in paragraphs. It can be also a logical: in this case, if TRUE (default) the value is optimised in order to align lines with the first line.
prefix	Character: prefix for each line except the first.
initial	Character: prefix for the first line.

Details

Several functions print messages in different formats (message, error, warning, cat, R output) and with different syntaxes (concatenating parameters or accepting a single argument, appending a new line, etc.). This accessory function provides a common interface for different types: several arguments are accepted and concatenated with the sep argument; the format is defined with the format argument; a date is optionally placed before the message.

Value

Message (in the defined format).

Note

License: GPL 3.0

Author(s)

Luigi Ranghetti, phD (2020)

References

L. Ranghetti, M. Boschetti, F. Nutini, L. Busetto (2020). "sen2r": An R toolbox for automatically downloading and preprocessing Sentinel-2 satellite data. Computers & Geosciences, 139, 104473. \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.cageo.2020.104473")}, URL: https://sen2r.ranghetti.info/.

sen2r documentation built on Nov. 10, 2023, 9:08 a.m.