print_header: Customized knitr header

Description Usage Arguments Value Note Author(s) See Also Examples

View source: R/reportR.R

Description

This function prints a knitr header to the console, which can be copied and pasted to the top of an Rmd file. The header includes a ruled line underneath the document information followed by vertical whitespace.

Usage

1

Arguments

title

Character string for document title. Required.

author

Character string for document author. Required.

date

Character string for document date. Optional; defaults to current date formatted as DD Month YYYY.

Value

Returns a knitr header printed to the console.

Note

This function assumes the document will be styled with "style.css"."

Author(s)

Erica Wozniak

See Also

reportR

Examples

1
2
3
4
5
6
7
8
9
# Minimal required inputs
print_header(title  = "Document Title",
             author = "Document Author")
             
# Altered date
# Minimal required inputs
print_header(title  = "Document Title",
             author = "Document Author",
             date   = "7-18-16")

emwozniak/reportR documentation built on May 13, 2017, 6:06 p.m.