qat_add_description: Description of a check

Description Usage Arguments Value Author(s) See Also Examples

View source: R/qat_add_description.R

Description

For each check in the workflow it is possible to add a description of the test. This will be saved into the XML result file under the description. This function adds a new or replace an existing description.

Usage

1
qat_add_description(workflowlist, listelem, description_text)

Arguments

workflowlist

A workflowlist like it will be created by qat\_config\_read\_workflow

listelem

Number of check, where the description should be added.

description_text

Text of the description.

Value

Give back the edited workflowlist.

Author(s)

Andre Duesterhus

See Also

qat_config_read_workflow

Examples

1
2
3
4
5
6
7
8
9
library("qat")
# read in workflow from systemfiles
filename_in <- system.file("extdata/workflowexample.xml", package="qat")
workflowlist <- qat_config_read_workflow(filename_in)
# add some more informations for the workflow
workflowlist <- qat_add_description(workflowlist, 1, "How the test works...")
filename_out <- "myworkflow_result.xml" 
# write edited workflow in current directory
qat_config_write_workflow(workflowlist, output_filename=filename_out) 

qat documentation built on May 30, 2017, 8:27 a.m.