reportStories {oRus}

Reporting Stories

Description

This function allows you to write the reports for the user stories if you didn't write them before on the analysis function. The key input is the output of ‘oRus::analyseStories()'.#’

Usage

reportStories(
  stories,
  sheetFilePath = NULL,
  reportFilePath = NULL,
  outputType = "html_document"
)

Arguments

stories

The stories produced by the analysis function.

sheetFilePath

The path and filename of the Excel sheet that will be stored; must include the '*.xlsx' extension. If no value is passed, the file will not be written.

reportFilePath

The path where the extensive report will be stored. It must include the correct extension (according to the type selected in the following argument). If no value is passed, the report won't be generated.

outputType

The type of document to be generated (from an RMarkdown). By default it is a PDF file. Options are: 'html_output' or 'pdf_output'.

See Also

Other Simplified Process: analyseStories(), createIgnoreWords()