@beauraines/sprint-tracker 0.6.13 → 0.6.15

package/.github/workflows/test.yaml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [16.x, '18.x', '20.x']
+        node-version: ['18.x', '20.x']
 
     steps:
       - uses: actions/checkout@v3

package/CHANGELOG.md

@@ -2,11 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### [0.6.13](https://github.com/beauraines/sprint-tracker/compare/v0.6.12...v0.6.13) (2024-04-14)
+### [0.6.15](https://github.com/beauraines/sprint-tracker/compare/v0.6.14...v0.6.15) (2024-05-17)
+
+
+### Features
+
+* combines stats and visualization plots ([#71](https://github.com/beauraines/sprint-tracker/issues/71)) ([34f1237](https://github.com/beauraines/sprint-tracker/commit/34f1237d4cbcaaa80c97392e9f494369377980ba))
+
+### [0.6.14](https://github.com/beauraines/sprint-tracker/compare/v0.6.12...v0.6.14) (2024-05-06)
+
+
+### Features
+
+* improves sprint statistics with patchwork ([#69](https://github.com/beauraines/sprint-tracker/issues/69)) ([a36c75b](https://github.com/beauraines/sprint-tracker/commit/a36c75ba68631b1e28b7f3970c77d126a0e16fa3))
 
 
 ### Bug Fixes
 
+* **deps:** bump cli-markdown from 3.2.2 to 3.2.3 ([#65](https://github.com/beauraines/sprint-tracker/issues/65)) ([bc3c912](https://github.com/beauraines/sprint-tracker/commit/bc3c912a331678a9e880939c7555257983a4f4c3))
 * **deps:** bump cli-table3 from 0.6.3 to 0.6.4 ([#63](https://github.com/beauraines/sprint-tracker/issues/63)) ([1487e95](https://github.com/beauraines/sprint-tracker/commit/1487e9531782b0575ad27664814461856c454ea4))
 
 ### [0.6.12](https://github.com/beauraines/sprint-tracker/compare/v0.6.9...v0.6.12) (2024-03-27)

package/R/combinedStats.R

@@ -0,0 +1,345 @@
+library(tidyverse)
+library(zoo)
+library(DBI)
+library(RSQLite)
+library(ggrepel)
+library(patchwork)
+
+args = commandArgs(trailingOnly=TRUE)
+if (length(args)==0) {
+  stop("At least one argument must be supplied, the key", call.=FALSE)
+}
+project_id = if_else(is.na(args[1]),"4",args[1])
+
+con <- dbConnect(RSQLite::SQLite(),"~/projects/sprint-tracker/tracker.db")
+
+#TODO simplify this sql and build the data set in R, maybe
+res <- dbSendQuery(con, str_c("WITH commitment as (
+select
+    p.name,
+    s.id sprint_id,
+    s.sprint_name,
+    s.start_date,
+    s.end_date,
+    so.story_points,
+    o.name as outcome,
+    o.id
+from 
+    sprint_outcomes so
+    JOIN sprints s on sprint_id = s.id 
+    JOIN projects p on project_id = p.id and p.id = ",project_id,
+    " JOIN outcomes o on outcome_id = o.id and outcome_id in (6) -- 1 Delivered, 6 Committment
+),
+completed as
+(
+select
+    p.name,
+    s.id sprint_id,
+    s.sprint_name,
+    s.start_date,
+    s.end_date,
+    so.story_points,
+    o.name as outcome,
+    o.id
+from 
+    sprint_outcomes so
+    JOIN sprints s on sprint_id = s.id 
+    JOIN projects p on project_id = p.id and p.id = ",project_id,
+    " JOIN outcomes o on outcome_id = o.id and outcome_id in (1) -- 1 Delivered, 6 Committment
+)
+
+select
+    commitment.name,
+    commitment.sprint_id,
+    commitment.sprint_name,
+    commitment.start_date,
+    commitment.end_date,
+    commitment.story_points commitment,
+    completed.story_points completed
+from
+commitment
+LEFT JOIN completed on completed.sprint_id = commitment.sprint_id
+where
+    1 =1
+order by commitment.name,commitment.start_date
+
+;
+"))
+
+
+# TODO query sqlite directly
+sprintData <- dbFetch(res)
+
+# Clear the result
+dbClearResult(res)
+
+# Disconnect from the database
+dbDisconnect(con)
+
+## Clean data
+# Remove Foo and Abe's project
+sprintData = sprintData %>% 
+  filter(!name %in% c('Foo','Abe\'s projct'))
+
+# How to deal with outliers
+
+## Add numbering
+sprintData = sprintData %>% 
+  group_by(name) %>% 
+  mutate(sprint_number = row_number()) %>%
+  add_count(name="project_sprint_count") %>%
+  mutate(project_percent_completed = sprint_number/project_sprint_count)
+
+
+## Add velocity
+
+sprintData = sprintData %>% 
+  group_by(name) %>% 
+  mutate(velocity = cumsum(completed)/sprint_number)
+
+## Add Completion Percentage
+sprintData = sprintData %>% 
+  group_by(name) %>% 
+  mutate(commitment_percentage = completed/commitment)
+
+
+
+f_labels <- sprintData %>%  summarise(
+  Velocity = sd(velocity, na.rm=TRUE) %>% formatC(digits = 3),
+  "Commitment Percentage" = sd(commitment_percentage, na.rm=TRUE) %>% formatC(digits = 3)
+  ) %>% 
+  select(!"name") %>% 
+  pivot_longer(
+    cols = c("Velocity", "Commitment Percentage"),
+    values_to = "label",
+    names_to = "measure" )
+
+
+sprintDataPivot = sprintData %>%
+    select(!c(completed,commitment,sprint_id,project_sprint_count,project_percent_completed)) %>%
+    pivot_longer(
+        c(velocity,commitment_percentage),
+        names_to =  "measure", 
+        values_to = "value"
+    )
+
+projectName = unique(sprintDataPivot$name)
+
+velocity <- sprintDataPivot %>%
+  filter(measure == 'velocity') %>%
+  ggplot(aes(x = reorder(str_wrap(sprint_name,15),sprint_number),
+             y = value
+             )) +
+  geom_line(group=1,color = "#b9b9b9") + 
+  geom_point(color = "#b9b9b9") +
+  # Add point values
+  geom_text_repel(
+    aes(label=round(value,2)),
+    direction = "y",
+    family = "roboto",
+    size = 10 * 5/14 * 0.8) +
+  # plot labels
+  labs(title=str_c(projectName,"Velocity", sep =" "),
+       x ="", 
+       y = "") +
+#themes
+  theme(
+    plot.title = element_text(family = "roboto"),
+    # NO x-axis labels
+    axis.title.x = element_blank(),
+    axis.text.x = element_blank(),
+    axis.title.y = element_text(family = "roboto"),
+    panel.grid.major.y = element_line(colour = "#D9D9D9"),
+    panel.grid.minor.y = element_line(colour = "#D9D9D9"),
+    panel.grid.major.x = element_blank(), panel.grid.minor.x = element_blank(),
+    # background color 
+    panel.background = element_rect(fill = "#D9D9D920", colour = NA),
+    legend.position = "bottom",
+    plot.background = element_rect(colour = "#D9D9D9", fill=NA)
+  )
+
+commitmentPercentage <- sprintDataPivot %>%
+  filter(measure == 'commitment_percentage') %>%
+  ggplot(aes(x = reorder(str_wrap(sprint_name,15),sprint_number),
+             y = value
+             )) +
+  geom_hline(yintercept = 1, color = "green") +
+  geom_hline(yintercept = .8, color = "yellow") +
+  geom_hline(yintercept = .6, color = "red") +
+  geom_line(group=1,color = "#b9b9b9") + 
+  geom_point(color = "#b9b9b9") +
+  # Add point values
+  geom_text_repel(
+    aes(label=scales::label_percent()(round(value,2))),
+    direction = "y",
+    family = "roboto",
+    size = 10 * 5/14 * 0.8) +
+  # plot labels
+  labs(title=str_c(projectName,"Commitment Percentage", sep =" "),
+       x ="", 
+       y = "") +
+  scale_y_continuous (labels = scales::percent) +
+#themes
+  theme(
+    plot.title = element_text(family = "roboto"),
+    # has x-axis labels because this is the bottom plot
+    # TODO are these axis labels actually needed with the columns below
+    # axis.title.x = element_text(family = "roboto"),
+    # axis.text.x = element_text(angle = 45, vjust = 1, hjust=1),
+    axis.title.x = element_blank(),
+    axis.text.x = element_blank(),
+    axis.title.y = element_text(family = "roboto"),
+    panel.grid.major.y = element_line(colour = "#D9D9D9"),
+    panel.grid.minor.y = element_line(colour = "#D9D9D9"),
+    panel.grid.major.x = element_blank(), panel.grid.minor.x = element_blank(),
+    # background color 
+    panel.background = element_rect(fill = "#D9D9D920", colour = NA),
+    legend.position = "bottom",
+    plot.background = element_rect(colour = "#D9D9D9", fill=NA)
+  )
+
+
+
+
+# Add StdDeviation to each plot
+velocity <- velocity + 
+  geom_label(
+    x = 1,
+    y = Inf,
+    aes(label = str_c("St Dev = ",label), hjust = "left", vjust = 1.3),
+    data = f_labels %>% filter(measure == 'Velocity')
+  )
+
+commitmentPercentage <- commitmentPercentage + 
+  geom_label(
+    x = 1,
+    y = Inf,
+    aes(label = str_c("St Dev = ",label), hjust = "left", vjust = 1.3),
+    data = f_labels %>% filter(measure == 'Commitment Percentage')
+  )
+
+
+
+# Add shading to commitment percentage plots
+commitmentPercentage <- commitmentPercentage + 
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=-Inf,ymax=0.6,fill=alpha(c("red"),0.1)) +
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=0.6,ymax=0.8,fill=alpha("yellow",0.1)) +
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=0.8,ymax=Inf,fill=alpha(c("green"),0.1))
+
+
+
+### Generate Sprint Outcomes
+
+# TODO - pull in the SQL here
+outcomes = read_csv(str_c(Sys.getenv("HOME"),"/","outcomes.csv"))
+
+outcomes <- outcomes %>% 
+  tibble() %>%
+  filter(story_points != 0) %>%
+  mutate(
+    end_date = as.Date(end_date)
+  )
+
+# compute velocity statistics
+
+entire_project_velocity = (outcomes %>% 
+                             filter(outcome == 'B-Delivered' ) %>% 
+                             summarize( average_velocity = mean(story_points)))$average_velocity
+
+average_velocity = (outcomes %>% 
+                      filter(outcome == 'B-Delivered') %>%
+                      filter(!sprint_name  %in% c('Accessibility Improvement 0','Accessibility Improvements 1')) %>%
+                      summarize( average_velocity = mean(story_points)))$average_velocity
+
+# Compute 95% band velocity
+
+outcomeColors = c("A-Commitment" = "#0B4F6C",
+                 "Carryover" = "#D34E24",
+                 "Carryover - External" = "#d3248d",
+                 "Descoped" ="#A39BA8",
+                 "Unplanned - Bug" ="#F28123",
+                 "Unplanned - Story" = "#F7F052",
+                 "B-Delivered" ="#00A878")
+outcomeFills = c("A-Commitment" = "#0B4F6C",
+                 "Carryover" = "#D34E24",
+                 "Carryover - External" = "#d3248d",
+                 "Descoped" ="#A39BA8",
+                 "Unplanned - Bug" ="#F28123",
+                 "Unplanned - Story" = "#F7F052",
+                 "B-Delivered" ="#00A878")
+
+chartTitle = str_c("Sprint Outcomes - ",unique(outcomes$project_name))
+
+outcomePlot <-ggplot(outcomes,
+             aes(fill=outcome,
+                 y=story_points,
+                 # x=end_date
+                 #x = str_wrap(sprint_name,15)
+                 x = reorder(str_wrap(sprint_name,15),end_date)
+                 )
+             )+
+  geom_bar(position="dodge", stat="identity",color = "black") +
+  # add bar labels
+  geom_text(data = outcomes %>% mutate(story_points = na_if(story_points,0)),
+            aes(label=story_points, y = story_points + .5),
+            position = position_dodge(0.9)) +
+  # trendline
+  geom_smooth(aes(#x=factor(end_date),
+                  x=factor(reorder(str_wrap(sprint_name,15),end_date)),
+                  y=story_points,group=outcome),
+              data = outcomes%>%filter(outcome=="B-Delivered"),
+              #method = "lm", # no method = curved line
+              se=FALSE,
+              show.legend = FALSE,
+              linetype = "dashed",
+              color = "#00A878") +
+  # TODO better position this annotation
+  annotate(geom="text",
+           x=length(unique(outcomes$sprint_name))+.25,
+           y=average_velocity + 1.5,
+           label="Trend Line") +
+  # average velocity line
+  geom_hline(yintercept=average_velocity,linetype = "dotted", color = "#00A878") +
+  annotate(geom="text", x=.75, y=average_velocity + 1.5, label="Average\nVelocity") +
+  # plot labels
+  labs(title=chartTitle,
+       # subtitle = 'Excluding the Data Science, Product Ownership and QA Teams',
+       x ="", 
+       y = "Story Points", 
+       fill='Outcomes') +
+  #colors
+  scale_colour_manual(values = outcomeColors) + 
+  scale_fill_manual(values = outcomeFills) +
+  #themes
+  theme(
+    plot.title = element_text(family = "roboto"),
+    axis.title.x = element_text(family = "roboto"),
+    axis.text.x = element_text(angle = 45, vjust = 1, hjust=1),
+    axis.title.y = element_text(family = "roboto"),
+    panel.grid.major.y = element_line(colour = "#D9D9D9"), panel.grid.minor.y = element_line(colour = "#D9D9D9"),
+    panel.grid.major.x = element_blank(), panel.grid.minor.x = element_blank(),
+    # background color 
+    panel.background = element_rect(fill = "#D9D9D920", colour = NA),
+    legend.position = "bottom",
+    plot.background = element_rect(colour = "#D9D9D9", fill=NA)
+  ) 
+
+
+
+
+
+
+
+statsPlot <- velocity /
+commitmentPercentage /
+outcomePlot
+
+
+
+
+# plot
+
+
+ggsave(str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),plot=statsPlot,bg="white", width = 2882, height = 1700, units =  "px")
+
+print(str_c("Saving to ",str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),sep = " "))

package/R/commitmentVarianceCli.R

@@ -3,6 +3,7 @@ library(zoo)
 library(DBI)
 library(RSQLite)
 library(ggrepel)
+library(patchwork)
 
 args = commandArgs(trailingOnly=TRUE)
 if (length(args)==0) {
@@ -54,8 +55,7 @@ select
     commitment.start_date,
     commitment.end_date,
     commitment.story_points commitment,
-    completed.story_points completed,
-    (completed.story_points*1.0 - commitment.story_points*1.0)/commitment.story_points * 100.0  commitment_variance
+    completed.story_points completed
 from
 commitment
 LEFT JOIN completed on completed.sprint_id = commitment.sprint_id
@@ -106,54 +106,27 @@ sprintData = sprintData %>%
 
 f_labels <- sprintData %>%  summarise(
   Velocity = sd(velocity, na.rm=TRUE) %>% formatC(digits = 3),
-  "Commitment Variance" = sd(commitment_variance, na.rm=TRUE) %>% formatC(digits = 3),
   "Commitment Percentage" = sd(commitment_percentage, na.rm=TRUE) %>% formatC(digits = 3)
   ) %>% 
   select(!"name") %>% 
   pivot_longer(
-    cols = c("Velocity", "Commitment Variance", "Commitment Percentage"),
+    cols = c("Velocity", "Commitment Percentage"),
     values_to = "label",
     names_to = "measure" )
 
 
-# commitment_variance
-# sprintData %>%
-#   ggplot(aes(x = sprint_number,
-#              y = commitment_variance,
-#              colour = name)) +
-#   geom_line() + 
-#   geom_point()
-
-
-
-# Sprint Velocity
-# sprintData %>%
-#   ggplot(aes(x = sprint_number,
-#              y = velocity,
-#              colour = name)) +
-#   geom_line() + 
-#   geom_point()
-
-# Commitment Percentage
-# sprintData %>%
-#   ggplot(aes(x = commitment_percentage,
-#              y = velocity,
-#              colour = name)) +
-#   geom_line() + 
-#   geom_point()
-
-
 sprintDataPivot = sprintData %>%
     select(!c(completed,commitment,sprint_id,project_sprint_count,project_percent_completed)) %>%
     pivot_longer(
-        c(velocity,commitment_percentage,commitment_variance),
+        c(velocity,commitment_percentage),
         names_to =  "measure", 
         values_to = "value"
     )
 
 projectName = unique(sprintDataPivot$name)
 
-plot <- sprintDataPivot %>%
+velocity <- sprintDataPivot %>%
+  filter(measure == 'velocity') %>%
   ggplot(aes(x = reorder(str_wrap(sprint_name,15),sprint_number),
              y = value
              )) +
@@ -166,12 +139,50 @@ plot <- sprintDataPivot %>%
     family = "roboto",
     size = 10 * 5/14 * 0.8) +
   # plot labels
-  labs(title=str_c(projectName,"Sprint Statistics", sep =" "),
+  labs(title=str_c(projectName,"Velocity", sep =" "),
        x ="", 
        y = "") +
 #themes
   theme(
     plot.title = element_text(family = "roboto"),
+    # NO x-axis labels
+    axis.title.x = element_blank(),
+    axis.text.x = element_blank(),
+    axis.title.y = element_text(family = "roboto"),
+    panel.grid.major.y = element_line(colour = "#D9D9D9"),
+    panel.grid.minor.y = element_line(colour = "#D9D9D9"),
+    panel.grid.major.x = element_blank(), panel.grid.minor.x = element_blank(),
+    # background color 
+    panel.background = element_rect(fill = "#D9D9D920", colour = NA),
+    legend.position = "bottom",
+    plot.background = element_rect(colour = "#D9D9D9", fill=NA)
+  )
+
+commitmentPercentage <- sprintDataPivot %>%
+  filter(measure == 'commitment_percentage') %>%
+  ggplot(aes(x = reorder(str_wrap(sprint_name,15),sprint_number),
+             y = value
+             )) +
+  geom_hline(yintercept = 1, color = "green") +
+  geom_hline(yintercept = .8, color = "yellow") +
+  geom_hline(yintercept = .6, color = "red") +
+  geom_line(group=1,color = "#b9b9b9") + 
+  geom_point(color = "#b9b9b9") +
+  # Add point values
+  geom_text_repel(
+    aes(label=scales::label_percent()(round(value,2))),
+    direction = "y",
+    family = "roboto",
+    size = 10 * 5/14 * 0.8) +
+  # plot labels
+  labs(title=str_c(projectName,"Commitment Percentage", sep =" "),
+       x ="", 
+       y = "") +
+  scale_y_continuous (labels = scales::percent) +
+#themes
+  theme(
+    plot.title = element_text(family = "roboto"),
+    # has x-axis labels because this is the bottom plot
     axis.title.x = element_text(family = "roboto"),
     axis.text.x = element_text(angle = 45, vjust = 1, hjust=1),
     axis.title.y = element_text(family = "roboto"),
@@ -184,23 +195,46 @@ plot <- sprintDataPivot %>%
     plot.background = element_rect(colour = "#D9D9D9", fill=NA)
   )
 
-plot <- plot + facet_wrap(
-    vars(str_to_title(sub("_"," ",measure))),
-    ncol = 1,
-    scales = "free_y"
-    )
 
-plot <- plot + 
+
+
+# Add StdDeviation to each plot
+velocity <- velocity + 
   geom_label(
     x = 1,
     y = Inf,
     aes(label = str_c("St Dev = ",label), hjust = "left", vjust = 1.3),
-    data = f_labels
+    data = f_labels %>% filter(measure == 'Velocity')
   )
 
+commitmentPercentage <- commitmentPercentage + 
+  geom_label(
+    x = 1,
+    y = Inf,
+    aes(label = str_c("St Dev = ",label), hjust = "left", vjust = 1.3),
+    data = f_labels %>% filter(measure == 'Commitment Percentage')
+  )
+
+
+
+# Add shading to commitment percentage plots
+commitmentPercentage <- commitmentPercentage + 
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=-Inf,ymax=0.6,fill=alpha(c("red"),0.1)) +
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=0.6,ymax=0.8,fill=alpha("yellow",0.1)) +
+  annotate(geom ="rect",xmin=-Inf,xmax=Inf,ymin=0.8,ymax=Inf,fill=alpha(c("green"),0.1))
+
+
+
+
+statsPlot <- velocity /
+commitmentPercentage 
+
+
+
+
 # plot
 
 
-ggsave(str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),plot=plot,bg="white", width = 2882, height = 1700, units =  "px")
+ggsave(str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),plot=statsPlot,bg="white", width = 2882, height = 1700, units =  "px")
 
 print(str_c("Saving to ",str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),sep = " "))

package/cmds/stats.js

@@ -45,7 +45,7 @@ const handler = async function () {
 	}
 
     console.log('Making statistics visualizations')
-    const cmd = `Rscript ${__dirname}/../R/commitmentVarianceCli.R ${project_id}`
+    const cmd = `Rscript ${__dirname}/../R/combinedStats.R ${project_id}`
     exec(cmd, function(err, stdout, stderr) {
     if (err) {
         console.log(stderr);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/sprint-tracker",
-  "version": "0.6.13",
+  "version": "0.6.15",
   "description": "Database and R visualizations to track sprint performance",
   "main": "cli.js",
   "bin": {