trackr_timepoint: trackr_timepoint

In hamishgibbs/rtrackr: What the Package Does (One Line, Title Case)

Description

Log a timepoint in the data processing chain.

Usage

trackr_timepoint(
  dataframe,
  trackr_dir = NULL,
  timepoint_message = NULL,
  log_data = TRUE,
  suppress_success = FALSE
)

Arguments

dataframe	A data.frame, the data to be logged.
trackr_dir	A string, path to store trackr log files.
timepoint_message	A string (optional), a message to identify the timepoint - similar to a git commit message.
log_data	A boolean (optional), output a full dataset log with each trackr file. Default is "TRUE"
suppress_success	A boolean (optional), suppress success messages. Default is "FALSE".

Value

A data.frame with an updated trackr_id column. Trackr log and data log files are written into the trackr_dir.

hamishgibbs/rtrackr documentation built on June 25, 2020, 8:16 p.m.