createHeader: Makes header for R script

Description Usage Arguments Details Value

View source: R/functions.R

Description

This function makes the header for the report R script to be rendered by knitr into Rmarkdown and rendered into HTML, PDF, or Word.

Usage

1
2
3
4
5
6
7
8
createHeader(
  title = "MicrobiomeExplorer Report",
  author = "",
  date = "",
  data.source = "",
  output = getOption("me.reportformat"),
  toc = TRUE
)

Arguments

title

Title of the report.

author

Author of the report.

date

Date of the report.

data.source

R code used to obtain the dataset

output

Output of Rmarkdown file.

toc

Table of contents. Default is TRUE.

Details

This was adapted from https://yihui.name/knitr/demo/stitch/

Value

A character vector where each element is a line in the R script.


microbiomeExplorer documentation built on Nov. 8, 2020, 8:16 p.m.