diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/hierarchical_kinetics.Rd | 2 | ||||
-rw-r--r-- | man/mkinmod.Rd | 2 | ||||
-rw-r--r-- | man/summary_listing.Rd | 27 | ||||
-rw-r--r-- | man/tex_listing.Rd | 21 |
4 files changed, 29 insertions, 23 deletions
diff --git a/man/hierarchical_kinetics.Rd b/man/hierarchical_kinetics.Rd index 4bb82a4c..2a8e211c 100644 --- a/man/hierarchical_kinetics.Rd +++ b/man/hierarchical_kinetics.Rd @@ -23,7 +23,7 @@ provided with the mkin package. \dontrun{ library(rmarkdown) -draft("New analysis.rmd", template = "hierarchical_kinetics", package = "mkin") +draft("example_analysis.rmd", template = "hierarchical_kinetics", package = "mkin") } } diff --git a/man/mkinmod.Rd b/man/mkinmod.Rd index 87ce9016..65b5de1a 100644 --- a/man/mkinmod.Rd +++ b/man/mkinmod.Rd @@ -33,7 +33,7 @@ the source compartment. Additionally, \code{\link[=mkinsub]{mkinsub()}} has an argument \code{to}, specifying names of variables to which a transfer is to be assumed in the model. If the argument \code{use_of_ff} is set to "min" -(default) and the model for the compartment is "SFO" or "SFORB", an +and the model for the compartment is "SFO" or "SFORB", an additional \code{\link[=mkinsub]{mkinsub()}} argument can be \code{sink = FALSE}, effectively fixing the flux to sink to zero. In print.mkinmod, this argument is currently not used.} diff --git a/man/summary_listing.Rd b/man/summary_listing.Rd new file mode 100644 index 00000000..995ebd8d --- /dev/null +++ b/man/summary_listing.Rd @@ -0,0 +1,27 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/summary_listing.R +\name{summary_listing} +\alias{summary_listing} +\alias{tex_listing} +\alias{html_listing} +\title{Display the output of a summary function according to the output format} +\usage{ +summary_listing(object, caption = NULL, label = NULL, clearpage = TRUE) + +tex_listing(object, caption = NULL, label = NULL, clearpage = TRUE) + +html_listing(object, caption = NULL) +} +\arguments{ +\item{object}{The object for which the summary is to be listed} + +\item{caption}{An optional caption} + +\item{label}{An optional label, ignored in html output} + +\item{clearpage}{Should a new page be started after the listing? Ignored in html output} +} +\description{ +This function is intended for use in a R markdown code chunk with the chunk +option \code{results = "asis"}. +} diff --git a/man/tex_listing.Rd b/man/tex_listing.Rd deleted file mode 100644 index 2f11d211..00000000 --- a/man/tex_listing.Rd +++ /dev/null @@ -1,21 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/tex_listing.R -\name{tex_listing} -\alias{tex_listing} -\title{Wrap the output of a summary function in tex listing environment} -\usage{ -tex_listing(object, caption = NULL, label = NULL, clearpage = TRUE) -} -\arguments{ -\item{object}{The object for which the summary is to be listed} - -\item{caption}{An optional caption} - -\item{label}{An optional label} - -\item{clearpage}{Should a new page be started after the listing?} -} -\description{ -This function can be used in a R markdown code chunk with the chunk -option \code{results = "asis"}. -} |