File: pandoc.formula.return.Rd

package info (click to toggle)
r-cran-pander 0.6.3%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,804 kB
  • sloc: javascript: 301; cpp: 145; lisp: 94; makefile: 21
file content (33 lines) | stat: -rw-r--r-- 1,022 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/pandoc.R
\name{pandoc.formula.return}
\alias{pandoc.formula.return}
\alias{pandoc.formula}
\title{Formulas}
\usage{
pandoc.formula.return(x, text = NULL, max.width = 80, caption,
  add.line.breaks = FALSE, ...)
}
\arguments{
\item{x}{formula}

\item{text}{text to be written before result in the same line. Typically used by calls from other functions in the package}

\item{max.width}{maximum width in characters per line}

\item{caption}{caption (string) to be shown under the formula}

\item{add.line.breaks}{if to add 2 line breaks after formula}

\item{...}{extra arguments passed by from parent call, disregarded}
}
\value{
By default this function outputs (see: \code{cat}) the result. If you would want to catch the result instead, then call the function ending in \code{.return}.
}
\description{
Pandoc's mardown formula.
}
\examples{
pandoc.formula(y ~ x)
pandoc.formula(formula(paste('y ~ ', paste0('x', 1:12, collapse = ' + '))))
}