Prints YAML templates for either a plan or to-do list to the console as an example for developing your own custom plans and to-do lists. Inspired by similar template_ functions included in the pkgdown package.

template_yaml(template = c("plan", "todo"))

Arguments

template

One of "plan" or "todo" denoting template desired

Value

Prints template to console

Details

Note that depending on the console, text editor, and settings you are using, the template may or may not preserve the necessary whitespace shown in the output. If you copy-paste the template for modification, ensure that it still adheres to traditional YAML indentation.

See also

Other plans and todos: post_plan(), post_todo(), read_plan(), read_todo(), report_plan(), report_todo()

Examples

template_yaml('plan')
#> - title: Enter a short, informative title of your goal #> description: > #> Enter a longer description of the objectives #> due_on: 2018-12-31T12:59:59Z #> issue: #> - title: Title of task 1 to complete #> body: Describe this step #> assignees: [emilyriederer] #> labels: [a, b, c] #> - title: Title of task 2 to complete #> body: Describe this step #> labels: [low] #> #> - title: Enter another short, informative title of your goal #> description: > #> Enter a longer description of the objectives #> issue: #> - title: Title of task 1 to complete for step 2 #> body: Describe this step #> - title: Title of task 2 to complete for step 2 #> body: Describe this step
template_yaml('todo')
#> - title: Informative title #> body: > #> Longer description of issue #> assignees: [emilyriederer] #> labels: [low] #> #> - title: Another informative title - body not required!