Skip to content

Commit

Permalink
Added documentation for self_contained option runReport->render->html…
Browse files Browse the repository at this point in the history
…_document
  • Loading branch information
borauyar committed Oct 10, 2016
1 parent 16c2805 commit 03f047b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
8 changes: 6 additions & 2 deletions R/report_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,10 @@ findLongLines <- function (myfile, lineLimit = 80) {
#' total number of query regions should be given.
#' @param quiet boolean value (default: FALSE). If set to TRUE, progress bars
#' and chunk labels will be suppressed while knitting the Rmd file.
#' @param selfContained boolean value (default: TRUE). By default, the generated
#' html file will be self-contained, which means that all figures and tables
#' will be embedded in a single html file with no external dependencies
#' (See rmarkdown::html_document)
#' @return An html generated using rmarkdown/knitr/pandoc that contains
#' interactive figures, tables, and text that provide an overview of the
#' experiment
Expand Down Expand Up @@ -906,8 +910,8 @@ runReport <- function(queryFilePath = 'testdata',
toc_float = TRUE,
theme = 'simplex',
number_sections = TRUE,
includes = rmarkdown::includes(in_header = headerFile),
selfContained = selfContained
includes = rmarkdown::includes(in_header = headerFile),
self_contained = selfContained
),
params = list(query = queryFilePath,
gff = gffFilePath,
Expand Down
7 changes: 6 additions & 1 deletion man/runReport.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 03f047b

Please sign in to comment.