UBIquitous-package: UBIquitous: A Package for Generation of Structured Reports

In amar00k/UBIquitous: A Package for Generation of Structured Reports

Description

This package allows the user to create HTML reports by specifying a document structure consisting of sections and *chunks*. It includes modules to process NGS datasets.

Chunks

Chunks are displayable elements in a report (e.g. a table, a figure, a paragraph).

text_chunk specifies a piece of text. table_chunk specifies a table. figure_chunk specifies a figure.

iris_section <- function(num.rows, colors) tab1 <- table_chunk(head(iris, num.rows), title = "The iris dataset", description = paste("This table displays the first", num.rows, "rows of the iris dataset."))

fig1 <- figure_chunk(fun = function() pairs(iris, col=colors[ iris$Species ]) , title = "Pairs plot of iris", description = "")

par = extract_parameters()

section( title = "Iris", description = "A section about the iris dataset.", chunks = list(tab1, fig1), par = par )

sec1 <- iris_section(6, colors = c("red", "green", "blue")) document <- list(sections=list(sec1)) render_document(document, filename = "Example1.html")

Author(s)

Daniel Neves, [e-mail]

amar00k/UBIquitous documentation built on May 28, 2019, 3:34 p.m.