agile_configuration: Agile Calendar Configuration
In paullemmens/agilecalendar: Create and Visualize an Agile Cadence Calendar
agile_configuration R Documentation
Agile Calendar Configuration
Description
The Agile calendar is defined and constructed using the
values inside the configuration YAML. A personal copy can be made
using the copy_default_config() function.
Format
The YAML (file) with the configuration and markers comprises
three sections: configuration, agile_events, and markers of
which the latter two have a somewhat interchangeable role.
configuration should have the following items below it (without
deeper hierarchies).
projectA simple label to mark the name of a project or
something else that might be relevant to display. Currently
used more as mnemonic that actually used in the calendar.
yearSimple number that is used to prefix the descriptive
labels for the increments and iterations (e.g. PI 22.x.y and
22 here then is the value for year.
year_startDate of the first Monday of the (next) Agile
year. This value is converted to a date stamp that is used to
offset all other calculations for laying out the Agile year
and calendar. Should be presented as YYYY-mm-dd.
increment_length, iteration_lengthThe duration in
weeks of an increment (a quarter) and an iteration (a sprint).
ip_lengthThe duration of the Innovation and Planning
iteration (in weeks).
The agile_events section is used to add markers on the Agile
calendar that directly relate to the Agile cadence. This contrasts
(a little) with the markers section that is/could be used for
markers for (more personal) reminders about, for instance,
deadlines. Both sections comprise any number of elements which
then have one or more dates where to add markers. The name of
each subsection is used for the marker label.
The date where these markers need to be plotted can be expressed in
two ways: as an absolute date or as a "relative" date expressed as,
for instance, the nth week in the increment or iteration. See the
default configuration for examples.
paullemmens/agilecalendar documentation built on March 11, 2023, 1:51 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| agile_configuration | R Documentation |
Agile Calendar Configuration
Description
The Agile calendar is defined and constructed using the
values inside the configuration YAML. A personal copy can be made
using the copy_default_config() function.
Format
The YAML (file) with the configuration and markers comprises
three sections: configuration, agile_events, and markers of
which the latter two have a somewhat interchangeable role.
configuration should have the following items below it (without
deeper hierarchies).
projectA simple label to mark the name of a project or something else that might be relevant to display. Currently used more as mnemonic that actually used in the calendar.
yearSimple number that is used to prefix the descriptive labels for the increments and iterations (e.g. PI 22.x.y and 22 here then is the value for
year.year_startDate of the first Monday of the (next) Agile year. This value is converted to a date stamp that is used to offset all other calculations for laying out the Agile year and calendar. Should be presented as YYYY-mm-dd.
increment_length,iteration_lengthThe duration in weeks of an increment (a quarter) and an iteration (a sprint).
ip_lengthThe duration of the Innovation and Planning iteration (in weeks).
The agile_events section is used to add markers on the Agile
calendar that directly relate to the Agile cadence. This contrasts
(a little) with the markers section that is/could be used for
markers for (more personal) reminders about, for instance,
deadlines. Both sections comprise any number of elements which
then have one or more dates where to add markers. The name of
each subsection is used for the marker label.
The date where these markers need to be plotted can be expressed in two ways: as an absolute date or as a "relative" date expressed as, for instance, the nth week in the increment or iteration. See the default configuration for examples.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.