make_stamp: Build a datastamp

Description Usage Arguments Details Value Examples

View source: R/stamp.R

Description

Searches for relevant data to make a datastamp.

Usage

1
2
3
4
5
6
7
make_stamp(
  script = NULL,
  time = NULL,
  system = NULL,
  session = NULL,
  files = NULL
)

Arguments

script

A logical to include the likely script of origin (default: TRUE).

time

A logical to include a timestamp in the datastamp (default: TRUE).

system

A logical to include system information (default: TRUE).

session

A logical to include session information (default: TRUE)

files

A character vector with file paths.

Details

When the script, time, system or session arguments are NULL the global options are searched for "datastamp.*" options, wherein the * is replaced by the argument names.

Value

A list of the class datastamp.

Examples

1
2
3
4
5
6
7
8
9
# Default stamp
stamp <- make_stamp()

# Not including some information:
make_stamp(session = FALSE)

# Alternatively:
options("datastamp.session" = FALSE)
make_stamp()

teunbrand/datastamp documentation built on Dec. 31, 2020, 8:34 a.m.