Analysing Stories

Main function that fully automates the process of analysing a dataset of user stories. It can also write results as an Excel sheet in a given directory, and generate an advanced report with highlights of missing features.

analyseStories(
  storiesFile,
  groupsNumber,
  topGroups = 1,
  sheetFilePath = NULL,
  reportFilePath = NULL,
  outputType = "pdf_document",
  ignoreWordsList = NULL
)

Arguments

storiesFile	The path an name to a text file containing one user story per line. They need to be written in English.
groupsNumber	The number of groups you want to generate between user stories.
topGroups	How many groups per stories you want to keep. The default is 1.
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.
ignoreWordsList	The list of words that you want to avoid using during the grouping of user stories. If nothing is passed, a default list will be used.

Value

A list of two datasets: the first one contains the stories split up, classified in types, analysed and grouped. Second dataframe contains top words per group and the belonging value of the word.

Examples

# Libraries for the example
library(reshape2)
#> Warning: package 'reshape2' was built under R version 3.6.3

# Transform the stories
fileUrl <- example_stories()
stories <- analyseStories(fileUrl, 7)
#> Joining, by = "word"
#> Joining, by = "word"
#> Warning: Column `word` joining character vector and factor, coercing into character vector

# Print some information
head(dplyr::as_tibble(stories[[2]]))
#> # A tibble: 6 x 9
#>   storyId who    what          why          type  goal  location group belonging
#>     <int> <fct>  <chr>         <chr>        <chr> <lgl> <lgl>    <int>     <dbl>
#> 1       4 manag~ put the stor~ we always h~ cons~ NA    NA           4     0.991
#> 2       5 manag~ define the o~ all of them~ cons~ NA    NA           3     0.997
#> 3       6 manag~ limit the pe~ i can reduc~ cons~ NA    NA           6     0.985
#> 4       7 manag~ assign worki~ i can evalu~ cons~ NA    NA           1     0.978
#> 5       8 manag~ limit the nu~ we do not o~ cons~ NA    NA           1     0.985
#> 6       9 manag~ simulate clo~ i can see w~ scen~ NA    NA           2     0.985

head(stories[[1]])
#> # A tibble: 6 x 3
#>   topic term       beta
#>   <int> <chr>     <dbl>
#> 1     1 hours     0.4  
#> 2     1 employees 0.2  
#> 3     1 database  0.2  
#> 4     1 employee  0.2  
#> 5     2 warehouse 0.333
#> 6     2 center    0.333

Arguments

Value

See also

Examples