monitor: Monitor the progress of a script

In Wytamma/monitauR: Remotely Monitor Script Progress

Monitor the progress of a script

Description

This function is used to monitor the progress of a script. A script file passed to the function will be evaluated and any comments with the comment_syntax #< (default) will be sent to a remote sever (API_URL) for logging. Before the script is evaluated the job will be initialised with the remote server and a Job ID is generated. That Job ID is used to link each step with the script. Once the script is finished the Job satus will be set to complete. If the script errors the error will also be logged with the server.

Usage

monitor(
  infile = NA,
  name = NA,
  token = NA,
  email = NA,
  API_URL = "https://monitaur-api.herokuapp.com",
  comment_syntax = "#<"
)

Arguments

infile	Path to the input file
name	Name of job (defaults to infile)
token	Token for grouping jobs (defaults to uuid)
email	Email to send notifications
API_URL	Base url of the remote server
comment_syntax	Special comment syntax (defaults to #<)

Value

The result of the script.

Wytamma/monitauR documentation built on March 26, 2022, 9:21 a.m.