File: RdSection2latex.Rd

package info (click to toggle)
r-cran-pkgmaker 0.27-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,152 kB
  • sloc: sh: 13; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 889 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
34
35
36
37
38
39
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rd.R
\name{RdSection2latex}
\alias{RdSection2latex}
\title{Format Rd Sections into LatTeX}
\usage{
RdSection2latex(topic, package, i = 1L, notitle = TRUE)
}
\arguments{
\item{topic}{Rd topic}

\item{package}{package in which to search the topic}

\item{i}{index of the section to format}

\item{notitle}{logical that indicates if the section's title should be removed}
}
\description{
This function extract sections from Rd files and convert them into
LaTeX code.
This can be useful to include Rd text into vignettes, hence keeping them
up to date.
}
\section{Example section}{
 This is a nice section, with a bullet list:
\itemize{
\item tata
\item toto
}
}

\examples{
\dontshow{
options(R_CHECK_RUNNING_EXAMPLES_=TRUE) ## roxygen generated flag
}

RdSection2latex('RdSection2latex', package = 'pkgmaker')

}