aboutsummaryrefslogtreecommitdiff
path: root/man/hierarchical_kinetics.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2022-12-19 12:31:56 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2022-12-19 12:38:07 +0100
commit886c9ef013124aa954d960c655b349b5340ff154 (patch)
treecc25364040ce87893d21581380de48c7e9bee422 /man/hierarchical_kinetics.Rd
parent0023df3c31fac29b5f9337ecd732a5dfd4d51a2d (diff)
Rename template folder, create format
Instead of rmarkdown::pdf_document, mkin::hierarchical_kinetics is used as a document format in the template. In this way, the template file can be freed from some R code and yaml options that the average user does not have to be aware of.
Diffstat (limited to 'man/hierarchical_kinetics.Rd')
-rw-r--r--man/hierarchical_kinetics.Rd29
1 files changed, 29 insertions, 0 deletions
diff --git a/man/hierarchical_kinetics.Rd b/man/hierarchical_kinetics.Rd
new file mode 100644
index 00000000..4bb82a4c
--- /dev/null
+++ b/man/hierarchical_kinetics.Rd
@@ -0,0 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/hierarchical_kinetics.R
+\name{hierarchical_kinetics}
+\alias{hierarchical_kinetics}
+\title{Hierarchical kinetics template}
+\usage{
+hierarchical_kinetics(..., keep_tex = FALSE)
+}
+\arguments{
+\item{...}{Arguments to \code{rmarkdown::pdf_document}}
+
+\item{keep_tex}{Keep the intermediate tex file used in the conversion to PDF}
+}
+\value{
+R Markdown output format to pass to
+\code{\link[rmarkdown:render]{render}}
+}
+\description{
+R markdown format for setting up hierarchical kinetics based on a template
+provided with the mkin package.
+}
+\examples{
+
+\dontrun{
+library(rmarkdown)
+draft("New analysis.rmd", template = "hierarchical_kinetics", package = "mkin")
+}
+
+}

Contact - Imprint