File: show-Style-method.Rd

package info (click to toggle)
r-cran-diffobj 0.3.5-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 2,432 kB
  • sloc: ansic: 455; javascript: 96; sh: 32; makefile: 8
file content (28 lines) | stat: -rwxr-xr-x 852 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/styles.R
\name{show,Style-method}
\alias{show,Style-method}
\alias{show,StyleHtml-method}
\title{Show Method for Style Objects}
\usage{
\S4method{show}{Style}(object)

\S4method{show}{StyleHtml}(object)
}
\arguments{
\item{object}{a \code{Style} S4 object}
}
\value{
NULL, invisibly
}
\description{
Display a small sample diff with the Style object styles applied.  For
ANSI light and dark styles, will also temporarily set the background and
foreground colors to ensure they are compatible with the style, even though
this is not done in normal output (i.e. if you intend on using a
\dQuote{light} style, you should set your terminal background color to be
light or expect sub-optimal rendering).
}
\examples{
show(StyleAnsi256LightYb())  # assumes ANSI colors supported
}