BiodbTestMsgAck {biodb} | R Documentation

## A class for acknowledging messages during tests.

### Description

A class for acknowledging messages during tests.

A class for acknowledging messages during tests.

### Details

This observer is used to call a testthat::expect_*() method each time a message is received. This is used when running tests on Travis-CI, so Travis does not stop tests because no change is detected in output.

### Methods

#### Public methods

- `BiodbTestMsgAck$new()`

- `BiodbTestMsgAck$notifyProgress()`

- `BiodbTestMsgAck$clone()`

#### Method `new()`

New instance initializer.

##### Usage

    BiodbTestMsgAck$new()

##### Returns

Nothing.

#### Method `notifyProgress()`

Call back method used to get progress advancement of a long process.

##### Usage

    BiodbTestMsgAck$notifyProgress(what, index, total)

##### Arguments

`what`

  The reason as a character value.

`index`

  The index number representing the progress.

`total`

  The total number to reach for completing the process.

##### Returns

Nothing.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    BiodbTestMsgAck$clone(deep = FALSE)

##### Arguments

`deep`

  Whether to make a deep clone.

### Examples

    # To use the acknowledger, set ack=TRUE when creating the Biodb test
    # instance:
    biodb <- biodb::createBiodbTestInstance(ack=TRUE)

    # Terminate the BiodbMain instance
    biodb$terminate()

[Package biodb version 1.2.2 Index]