@beauraines/sprint-tracker 0.6.10 → 0.6.12

package/CHANGELOG.md

@@ -2,12 +2,23 @@
 
 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.10](https://github.com/beauraines/sprint-tracker/compare/v0.6.9...v0.6.10) (2023-12-16)
+### [0.6.12](https://github.com/beauraines/sprint-tracker/compare/v0.6.9...v0.6.12) (2024-03-27)
+
+
+### Features
+
+* adds running statistics plot  ([#61](https://github.com/beauraines/sprint-tracker/issues/61)) ([76c1f00](https://github.com/beauraines/sprint-tracker/commit/76c1f0032b96a7afc7923f5100dcf4ef2ea59d56))
 
 
 ### Bug Fixes
 
+* comments out plot command and increments version number  ([#62](https://github.com/beauraines/sprint-tracker/issues/62)) ([ee18e17](https://github.com/beauraines/sprint-tracker/commit/ee18e17e7327f890f353841caed46dd04cc8fbe7))
+* **deps:** bump @json2csv/node from 7.0.1 to 7.0.4 ([#31](https://github.com/beauraines/sprint-tracker/issues/31)) ([68ed973](https://github.com/beauraines/sprint-tracker/commit/68ed973199df1a650ef7d677475bef1c23b144fd))
+* **deps:** bump @json2csv/node from 7.0.4 to 7.0.5 ([91a5e3b](https://github.com/beauraines/sprint-tracker/commit/91a5e3bf32c24874ae4f6c7bc52a155e9da6b35a))
+* **deps:** bump @json2csv/node from 7.0.5 to 7.0.6 ([#59](https://github.com/beauraines/sprint-tracker/issues/59)) ([1e2c7cb](https://github.com/beauraines/sprint-tracker/commit/1e2c7cb31af4074de33bd36c202dc82f6559eef8))
+* **deps:** bump cli-markdown from 3.2.0 to 3.2.2 ([e178633](https://github.com/beauraines/sprint-tracker/commit/e178633fde4fea487e0fe82fb0d6eab6a29d9a33))
 * **deps:** bump sqlite from 4.2.1 to 5.1.1 ([#28](https://github.com/beauraines/sprint-tracker/issues/28)) ([1fbc304](https://github.com/beauraines/sprint-tracker/commit/1fbc3049c9f218c5684699a5e320f34953d08a9f))
+* **deps:** bump sqlite3 from 5.1.6 to 5.1.7 ([3b8b3fb](https://github.com/beauraines/sprint-tracker/commit/3b8b3fb82aa37f295408c6372527bcd26bcf7dcc))
 
 ### [0.6.9](https://github.com/beauraines/sprint-tracker/compare/v0.6.8...v0.6.9) (2023-12-16)
 

package/R/commitmentVarianceCli.R

@@ -0,0 +1,206 @@
+library(tidyverse)
+library(zoo)
+library(DBI)
+library(RSQLite)
+library(ggrepel)
+
+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,
+    (completed.story_points*1.0 - commitment.story_points*1.0)/commitment.story_points * 100.0  commitment_variance
+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 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"),
+    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),
+        names_to =  "measure", 
+        values_to = "value"
+    )
+
+projectName = unique(sprintDataPivot$name)
+
+plot <- sprintDataPivot %>%
+  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,"Sprint Statistics", sep =" "),
+       x ="", 
+       y = "") +
+#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)
+  )
+
+plot <- plot + facet_wrap(
+    vars(str_to_title(sub("_"," ",measure))),
+    ncol = 1,
+    scales = "free_y"
+    )
+
+plot <- plot + 
+  geom_label(
+    x = 1,
+    y = Inf,
+    aes(label = str_c("St Dev = ",label), hjust = "left", vjust = 1.3),
+    data = f_labels
+  )
+
+# plot
+
+
+ggsave(str_c(Sys.getenv("HOME"),"/",str_replace(projectName," ",""),"SprintStats.png"),plot=plot,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

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+
+const { 	database: db	} = require('helpers')
+const { prompt } = require('../utils/input.js')
+const {readConfig} =  require('helpers').config
+const exec = require('child_process').exec;
+const process = require('process');
+
+const command = 'stats'
+const desc = 'Creates sprint statistics (Commitment variance, Commitment Percentage and Velocity ) with R. Requires a local R install'
+const builder = {}
+
+const handler = async function () {
+    // Get Data from Database and write to file
+    console.log('Getting data')
+
+	const filename = 'sprintTracker.json'
+	const config = await readConfig(filename)
+	const database = config.database
+
+	// list projects
+	
+	let statement = 'select * from projects;';
+
+	let projects = await db.query(database,statement)
+	
+	for (const project of projects) {
+        console.log(project.id, project.name)
+    }
+	
+	// Select the project
+	
+	// Select the project
+	let project_id
+
+	let text = 'Enter the project id: '
+	while (!project_id) {
+		project_id = prompt(text) 
+	
+		// validate the response
+		if (!projects.find(x => (x.id == project_id))) {
+			console.error('Invalid project id')
+			project_id = null
+		}
+	}
+
+    console.log('Making statistics visualizations')
+    const cmd = `Rscript ${__dirname}/../R/commitmentVarianceCli.R ${project_id}`
+    exec(cmd, function(err, stdout, stderr) {
+    if (err) {
+        console.log(stderr);
+        console.log(err.message)
+        process.exit(err.code)
+    }
+    console.log(stdout);
+    });
+}
+
+module.exports = {
+	command,
+	desc,
+	builder,
+	handler
+}

package/cmds/visualizations.js

@@ -11,7 +11,7 @@ const path = require('path');
 const process = require('process');
 
 const command = 'visualizations'
-const desc = 'Creates Feature Team visualizations with R. Must have docker, rstudio-tidyverse container and more installed'
+const desc = 'Creates sprint visualizations with R. Requires a local R install'
 const builder = {}
 
 const handler = async function () {

package/package.json

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

package/sql/commitmentVariance.sql

@@ -0,0 +1,52 @@
+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 = 11
+    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 = 11
+    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,
+    (completed.story_points*1.0 - commitment.story_points*1.0)/commitment.story_points * 100.0  commitment_variance
+from
+commitment
+LEFT JOIN completed on completed.sprint_id = commitment.sprint_id
+where
+    commitment.name in ('ALPR Data Enhancement','ECOM Enhancements')
+order by commitment.name,commitment.sprint_name