BiodbTestMsgAck: A class for acknowledging messages during tests.
In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases
BiodbTestMsgAck 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
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
whatThe reason as a character value.
indexThe index number representing the progress.
totalThe 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
deepWhether 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()
pkrog/biodb documentation built on Nov. 29, 2022, 4:24 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| BiodbTestMsgAck | 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
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
whatThe reason as a character value.
indexThe index number representing the progress.
totalThe 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
deepWhether 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()
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.