Read to-do list from YAML

Source: R/plan-todo.R

This function reads a carefully constructed YAML file representing a to-do list (of issues). YAML is converted into an R list structure which can then be passed to post_todo() to build infrastructure for your repository.

read_todo(input)

Arguments

input

Either filepath to YAML file or character string. Assumes filepath if ends in ".yml" and assumes string otherwise.

Value

List containing plan compatible with post_plan() or post_todo()

Details

Please see the "Building Custom Plans" vignette for more details.

See also

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

Examples

if (FALSE) {
# This example uses example file included in pkg
# You should be able to run example as-is after creating your own repo reference
file_path <- system.file("extdata", "todo.yml", package = "projmgr", mustWork = TRUE)
my_todo <- read_todo(file_path)
post_todo(ref, my_todo)
}