File: previewRd.Rd

package info (click to toggle)
r-cran-rstudioapi 0.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 592 kB
  • sloc: makefile: 2
file content (25 lines) | stat: -rw-r--r-- 433 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
 
\name{previewRd}
\alias{previewRd}

\title{
Preview an Rd topic in the Help pane
}
\description{
Preview an Rd topic in the Help pane
}
\note{
The \code{previewRd} function was added in version 0.98.191 of RStudio.
}

\usage{
previewRd(rdFile)
}
\arguments{
  \item{rdFile}{Single element character vector containing the name of the Rd file to be displayed}
}

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