fmStatus: Status class

Description Usage Arguments Details Value Examples

View source: R/utils.R

Description

This class is used to pass the background process results and metadata to the app. You can access the value directly (i.e. obj$value) or via fmGetValue() function (recommended!).

Usage

1
fmStatus(id, status, message, value = NULL)

Arguments

id

character string, task ID

status

character string

message

message that may be used on front-end to inform user what's happeninged

value

NULL for not-"success" tasks, the long function value for "success" tasks

Details

Possible statuses: - "running": task is running; - "failed": task has been stopped using fmError(); - "success": task completed succesfully; - "error": unexpected error occured in the long function; - "canceled": task has been canceled by the user

This function should NOT be used directly.

Value

fmStatus object

Examples

1
fmStatus("task1", "success", "Task completed successfully", iris)

Boehringer-Ingelheim/FutureManager documentation built on June 16, 2021, 6:23 p.m.