read_plan: Read plan from YAML

In projmgr: Task Tracking and Project Management with GitHub

Read plan from YAML

Description

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

Usage

read_plan(input)

Arguments

input

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

Details

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

Value

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

See Also

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

Examples

## Not run: 
# 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", "plan.yml", package = "projmgr", mustWork = TRUE)
my_plan <- read_plan(file_path)
post_plan(ref, my_plan)

## End(Not run)

projmgr documentation built on May 29, 2024, 5 a.m.