deleteTestBatches: delete one or more test batches from the master motus DB

View source: R/deleteTestBatches.R

deleteTestBatchesR Documentation

delete one or more test batches from the master motus DB

Description

delete one or more test batches from the master motus DB

Usage

deleteTestBatches(batchID)

Arguments

batchID

integer vector of IDs of batches to be deleted; only those which are marked in the DB as testing (i.e. whose 'status' field is -1) will be deleted.

Details

test batches are generated when a top-level job includes a TRUE 'isTesting' parameter. This is used for debugging.

Once such batches are in the master database, they will only be returned by the dataServer for API 'batches_for_*' calls that have 'includeTesting' set to TRUE, and only for admin users.

Regardless, it will sometimes be useful to remove test batches from the master DB.

Value

a logical vector of the same length as 'batchID', indicating which batches were successfully deleted.

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm


MotusWTS/motusServer documentation built on Dec. 3, 2024, 10:47 a.m.