TaskResults | R Documentation |
R6 class for TaskResults settings
id
unique identifier of results, helps in deriving final plot name
sectionId
unique identifier of section results, used only by qualification workflows
plot
ggplot
object corresponding to the figure to be saved
plotCaption
text included into the report explaining the figure
includePlot
logical indicating if the plot should be included in final report
table
data.frame corresponding to the table to be saved
tableCaption
text included into the report explaining the table
includeTable
logical indicating if the table should be included in final report
textChunk
text included into the report explaining the table
includeTextChunk
logical indicating if the text chunk should be included in final report
saveFigure()
Save ggplot figure, available as plot task result, into a file
TaskResults$saveFigure(fileName)
fileName
path of file corresponding to the figure to save
saveTable()
Save data.frame, available as table task result, into a csv file
TaskResults$saveTable(fileName)
fileName
path of csv file corresponding to the table to save
addFigureToReport()
Write markdown content that adds a figure, available as plot task result, into a markdown report To be displayed, figure path must be relative to report location
TaskResults$addFigureToReport(reportFile, fileRelativePath, fileRootDirectory)
reportFile
markdown file in which the figure and its caption should be added
fileRelativePath
figure path relative to reportFile
location
fileRootDirectory
root/working directory needed by tracelib
package
addTableToReport()
Write markdown content that adds a data.frame, available as table task result, into a markdown report
TaskResults$addTableToReport( reportFile, fileRelativePath, fileRootDirectory, digits = NULL, scientific = NULL )
reportFile
markdown file in which the table and its caption should be added
fileRelativePath
table path relative to reportFile
location
fileRootDirectory
root/working directory needed by tracelib
package
digits
number of decimal digits in displayed numbers
scientific
logical defining if displayed numbers use scientific writing
addTextChunkToReport()
Write markdown content that adds text, available as textChunk task result, into a markdown report
TaskResults$addTextChunkToReport(reportFile)
reportFile
markdown file in which the text should be added
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.