as.burndown: Create a burndown object

View source: R/burndown.R

as.burndownR Documentation

Create a burndown object

Description

Create a burndown object from the given data.

Usage

as.burndown(start, deadline, tasks, progress, progressInPercent = FALSE)

Arguments

start

Start date

deadline

Deadline (end date)

tasks

Data frame containing the task IDs (may be alphanumeric), their description and effort

progress

Data frame containing the progress values with task ID, timestamp and work done (either in percentage or absolute)

progressInPercent

boolean; if set to FALSE, progress values are treated like absolute values and converted to percentages

Details

Creates a burndown object from the given data; progress may be given in percentage or absolute values.

Value

A burndown object.

Author(s)

Frank Schmitt

See Also

Other things related to burndown data: burndown-class, burndown, plot,burndown-method, read.burndown(), summary,burndown-method

Examples

library(plan)
# same data as in tests/burndown.dat
start <- as.POSIXct(strptime("2006-04-08 12:00:00", "%Y-%m-%d %H:%M:%S"))
deadline <- as.POSIXct(strptime("2006-04-11 20:00:00", "%Y-%m-%d %H:%M:%S"))
tasks <- data.frame(key = c(1, 2, 3, 4, 5, 6),
                    description = c("code read.burndown()", "code summary.burndown()", 
                                    "code plot.burndown()", "create R package", 
                                    "write documentation", "set up website"),
                    effort = c(4, 1, 5, 2, 2, 1),
                    stringsAsFactors = FALSE)
progress <- data.frame(key = c(1, 2, 1, 2, 4, 5, 4, 1, 3, 3, 3, 2, 2, 1, 5, 5, 5, 1, 3, 6),
                       progress = c(5, 5, 10, 50, 5, 5, 100, 50, 5, 30, 80, 60, 
                                    100, 70, 30, 90, 100, 100, 100, 100),
                       time = structure(c(1144494000, 1144495800, 1144497600, 1144501200, 
                                          1144517400, 1144519200, 1144523760, 1144566600, 
                                          1144568460, 1144570680, 1144573200, 1144576800, 
                                          1144577400, 1144578600, 1144583400, 1144585200,
                                          1144585800, 1144586100, 1144586400, 1144591200), 
                                          class = "POSIXct"),
                       stringsAsFactors = FALSE
                       )
b <- as.burndown(start, deadline, tasks, progress, progressInPercent = TRUE)
summary(b)
plot(b)

plan documentation built on April 6, 2022, 5:08 p.m.