burn: Sample burndown dataset
In dankelley/burndown: Burndown charts and analysis

Description Usage Format Author(s) References

This is sample burndown dataset provided for testing.

1	data(burn)

A strict format is required, in which the following items must be present, in the stated order, and with nothing else in the file. An example is given after the description.

Line 1: contains two items, first the string Start, and second a time in ISO 8601 format (see below). A comma must separate the two.

Line 2: contains two items, first the string Deadline, and second a time in ISO 8601 format. Again, a comma must separate the items.

Line 3: blank

Line 4: a header line for a "task" list, comprising the following three words separated by a comma and any number of spaces: Key, Description, and Effort.

Lines 5 to N: a data line with three comma-separated items, first a numeric index "Key" for the task, second a "Description" of the task, and third the item's "Effort". The keys must be distinct, and they must match the keys in the progress table (next item). The effort is a number that may represent e.g. the number of hours or days for the task, or perhaps a percentage of the overall task.

Line N+1: blank

Line N+2: a header line for the "Progress" list, comprising the following four words separated by a comma and any number of spaces: Key, Done, Time, and Comment.

Line N+3 to end: data lines holding comma-separated Progress items. Each "Key" must match a key in the task list, or an error will occur during read.burndown(). The "Done" item is the percentage of completion of the task. The "Time" is in ISO 8601 format. Note that the list is ordered by time when it is read by read.burndown. The "Comment" is optional.

NB. an ISO 8601 date is formatted as "year-month-day", e.g. "2006-04-08" for the 8th of April, 2006. To add a time within the day, follow this by the letter "T" and then the time in colon-separated format hour:minute:second. (The second is optional.)

SAMPLE FILE

Start, 2006-04-08T12:00
Deadline, 2006-04-09T20:00

Key,     Description,                       Effort
1,code read.burndown(),                  4
2,code summary.burndown(),               1
3,code plot.burndown(),                  5
4,create R package,                      2
5,write documentation,                   2
6,set up website,                        1

Key,      Done,                      Time,          Comment
1,           5,           2006-04-08T13:00
2,           5,           2006-04-08T13:30
1,          10,           2006-04-08T14:00
2,          50,           2006-04-08T15:00
4,           5,           2006-04-08T19:30
5,           5,           2006-04-08T20:00
4,         100,           2006-04-08T21:16
1,          50,           2006-04-09T09:10
3,           5,           2006-04-09T09:41
3,          30,           2006-04-09T10:18
3,          80,           2006-04-09T11:00
2,          60,           2006-04-09T12:00
2,         100,           2006-04-09T12:10
1,          70,           2006-04-09T12:30
5,          30,           2006-04-09T13:50
5,          90,           2006-04-09T14:20
5,         100,           2006-04-09T14:30
1,         100,           2006-04-09T14:35
6,         100,           2006-04-09T16:00
3,         100,           2006-04-09T14:40