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.
read_plan(input)
| input | Either filepath to YAML file or character string. Assumes filepath if ends in ".yml" and assumes string otherwise. |
|---|
List containing plan compatible with post_plan() or post_todo()
Please see the "Building Custom Plans" vignette for more details.
Other plans and todos:
post_plan(),
post_todo(),
read_todo(),
report_plan(),
report_todo(),
template_yaml()
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", "plan.yml", package = "projmgr", mustWork = TRUE) my_plan <- read_plan(file_path) post_plan(ref, my_plan) }