template_yaml: Print YAML template to console

View source: R/plan-todo.R

template_yamlR Documentation

Print YAML template to console

Description

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.

Usage

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

Arguments

template

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

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.

Value

Prints template to console

See Also

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

Examples

template_yaml('plan')
template_yaml('todo')

emilyriederer/projmgr documentation built on Jan. 26, 2024, 3:09 a.m.