Description Usage Arguments Details Value See Also Examples
Interprets list representation of to-do list, using HTML to format results in a highly readable and
attractive way. Resulting object returned is a character vector of HTML code with the added
class of 'knit_asis'
so that when included in an RMarkdown document knitting to HTML,
the results will be correctly rendered as HTML.
1 | report_todo(todo, show_ratio = TRUE)
|
todo |
List of to-do list, as returned by |
show_ratio |
Boolean. Whether or not to report (# Closed Items / # Total Items) for each group as a ratio |
The resulting HTML unordered list (<ul>
) is tagged with class 'report_todo' for custom CSS styling.
Returns character string of HTML with class attribute to be correctly shown "as-is" in RMarkdown
Other plans and todos: post_plan
,
post_todo
, read_plan
,
read_todo
, report_plan
,
template_yaml
1 2 3 4 5 6 7 | ## Not run:
# the following could be run in RMarkdown
todo_path <- system.file("extdata", "todo-ex.yml", package = "projmgr", mustWork = TRUE)
my_todo <- read_todo(todo_path)
report_todo(my_todo)
## End(Not run)
|
[1] "<p/> <p> <strong> To Do </strong> <em>( 0 / 2 )</em> <ul class = 'report_todo' style = 'list-style: none;'> <li> ☐ Informative title </li> <li> ☐ Another informative title - body not required! </li> </ul> <p/>"
attr(,"class")
[1] "knit_asis" "character"
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.