yamlme (version 0.1.1)

print: Print Method for rmd_doc

Description

Quick display for rmd_doc objects. This method also defines the way how objects are displayed in the console.

Usage

# S3 method for rmd_doc
print(x, maxlines = 15, ...)

Value

A display of the resulting R-Markdown document in the console.

Arguments

x

An object of class rmd_doc.

maxlines

An integer value indicating the number of lines used for the display. Longer documents will be truncated.

...

Further arguments passed among methods (not yet in use).

Examples

## Create a new document
my_document <- write_rmd(
		title = "A journey in rOpenSci",
		author = "Miguel Alvarez",
		output = "html_document",
		body = read_rmd(file.path(path.package("yamlme"),
						"taxlistjourney.Rmd")))
my_document

if (FALSE) {
## Render the document
render_rmd(my_document, "taxlistjourney")
}