File: previewRd.Rd

package info (click to toggle)
r-cran-rstudioapi 0.17.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 916 kB
  • sloc: makefile: 2
file content (25 lines) | stat: -rw-r--r-- 465 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stubs.R
\name{previewRd}
\alias{previewRd}
\title{Preview an Rd topic in the Help pane}
\usage{
previewRd(rdFile)
}
\arguments{
\item{rdFile}{The path to an \code{.Rd} file.}
}
\description{
Preview an Rd topic in the Help pane.
}
\note{
The \code{previewRd} function was added in version 0.98.191 of
RStudio.
}
\examples{

\dontrun{
rstudioapi::previewRd("~/MyPackage/man/foo.Rd")
}

}