| Title: | RStudio Addin To Help Format 'roxygen2' |
|---|---|
| Description: | Insert, or replace text with, formatting code for 'roxygen2' function documentation in a package, like making text bold, inserting a URL, or linking to functions in other packages. |
| Authors: | Matt Dray [aut, cre] |
| Maintainer: | Matt Dray <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.0 |
| Built: | 2024-11-15 04:05:46 UTC |
| Source: | https://github.com/matt-dray/snorkel |
Take Time Out To Breathe
breathe(times = 3L, seconds = 5)breathe(times = 3L, seconds = 5)
times |
Numeric. Number of times to breathe. |
seconds |
Numeric. Number of seconds to take when inhaling and exhaling. |
Message printed to the console.
breathe()breathe()
Surround selected text with Rd markup for bold.
rd_bold()rd_bold()
Selected text: text
Result of function: \strong{text}
Example output with no text selection: \strong{}
The Writing R Extensions manual.
Surround selected text with Rd markup for inline code.
rd_code()rd_code()
User-selected text: text
Result of function: \code{text}
Example output with no text selection: \code{}
The Writing R Extensions manual.
Surround selected text with Rd markup for an email link.
rd_email()rd_email()
User-selected text: address
Result of function: \email{address}
Example output with no text selection: \email{}
The Writing R Extensions manual.
Surround selected text (in the form 'package::function') with Rd markup that links to a function in another package.
rd_fn_other_pkg()rd_fn_other_pkg()
User-selected text: package::function
Result of function: \code{\link[package]{function}}
Example output with no text selection: \code{\link[]{}}
The Writing R Extensions manual.
Surround selected text with Rd markup that links to a function in the current package.
rd_fn_this_pkg()rd_fn_this_pkg()
User-selected text: text
Result of function: \code{\link{text}}
Example output with no text selection: \code{\link{}}
The Writing R Extensions manual.
Surround selected text with Rd markup for italic.
rd_italic()rd_italic()
Selected text: text
Result of function: \emph{text}
Example output with no text selection: \emph{}
The Writing R Extensions manual.
Surround selected text (in the form 'package::function') with Rd markup that links to a function in another package and shows that package's name.
rd_link_fn_other_pkg_name()rd_link_fn_other_pkg_name()
User-selected text: package::function
Result of function: \code{\link[package:function]}
Example output with no text selection: \code{\link[:]}
The Writing R Extensions manual.
Surround selected text with Rd markup to link to an S4 class.
rd_link_s4_class()rd_link_s4_class()
User-selected text: class
Result of function: \linkS4class{class}
Example output with no text selection: \linkS4class{}
The Writing R Extensions manual.
Insert an Rd markup skeleton for a definition (named) list.
rd_list_definition()rd_list_definition()
Example output:
\describe{
\item{One}{First item}
\item{Two}{Second item}
}
The Writing R Extensions manual.
Insert an Rd markup skeleton for an ordered (numbered) list.
rd_list_ordered()rd_list_ordered()
Example output:
\enumerate{
\item First item
\item Second item
}
The Writing R Extensions manual.
Insert an Rd markup skeleton for an unordered (bulleted) list.
rd_list_unordered()rd_list_unordered()
Example output:
\itemize{
\item First item
\item Second item
}
The Writing R Extensions manual.
Surround selected text with Rd markup for package names.
rd_package()rd_package()
User-selected text: package
Result of function: \pkg{package}
Example output with no text selection: \pkg{}
The Writing R Extensions manual.
Surround selected URL text with Rd markup for a link to the web.
rd_url()rd_url()
User-selected text: url
Result of function: \url{url}
Example output with no text selection: \url{}
The Writing R Extensions manual.
Surround selected URL text with Rd markup for a link to the web and show a text label.
rd_url_named()rd_url_named()
User-selected text: url
Result of function: \href{url}{Link text}
Example output with no text selection: \href{}{Link text}
The Writing R Extensions manual.