The R Project SVN R

Rev

Rev 69345 | Rev 85908 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 69345 Rev 75350
Line 1... Line 1...
1
% File src/library/base/man/sQuote.Rd
1
% File src/library/base/man/sQuote.Rd
2
% Part of the R package, https://www.R-project.org
2
% Part of the R package, https://www.R-project.org
3
% Copyright 1995-2014 R Core Team
3
% Copyright 1995-2018 R Core Team
4
% Distributed under GPL 2 or later
4
% Distributed under GPL 2 or later
5
 
5
 
6
\name{sQuote}
6
\name{sQuote}
7
\alias{sQuote}
7
\alias{sQuote}
8
\alias{dQuote}
8
\alias{dQuote}
Line 10... Line 10...
10
\description{
10
\description{
11
  Single or double quote text by combining with appropriate single or
11
  Single or double quote text by combining with appropriate single or
12
  double left and right quotation marks.
12
  double left and right quotation marks.
13
}
13
}
14
\usage{
14
\usage{
15
sQuote(x)
15
sQuote(x, q = getOption("useFancyQuotes"))
16
dQuote(x)
16
dQuote(x, q = getOption("useFancyQuotes"))
17
}
17
}
18
\arguments{
18
\arguments{
19
  \item{x}{an \R object, to be coerced to a character vector.}
19
  \item{x}{an \R object, to be coerced to a character vector.}
-
 
20
  \item{q}{the kind of quotes to be used, see \sQuote{Details}.}
20
}
21
}
21
\details{
22
\details{
22
  The purpose of the functions is to provide a simple means of markup
23
  The purpose of the functions is to provide a simple means of markup
23
  for quoting text to be used in the R output, e.g., in warnings or
24
  for quoting text to be used in the R output, e.g., in warnings or
24
  error messages.
25
  error messages.
Line 42... Line 43...
42
  Some other locales also have the directional quotation marks, notably
43
  Some other locales also have the directional quotation marks, notably
43
  on Windows.  TeX uses grave and apostrophe for the directional single
44
  on Windows.  TeX uses grave and apostrophe for the directional single
44
  quotation marks, and doubled grave and doubled apostrophe for the
45
  quotation marks, and doubled grave and doubled apostrophe for the
45
  directional double quotation marks.
46
  directional double quotation marks.
46
 
47
 
47
  What rendering is used depend on the \code{\link{options}} setting for
48
  What rendering is used depends on \code{q} which by default depends on
-
 
49
  the \code{\link{options}} setting for \code{useFancyQuotes}.  If this
48
  \code{useFancyQuotes}.  If this is \code{FALSE} then the undirectional
50
  is \code{FALSE} then the undirectional
49
  ASCII quotation style is used.  If this is \code{TRUE} (the default),
51
  ASCII quotation style is used.  If this is \code{TRUE} (the default),
50
  Unicode directional quotes are used are used where available
52
  Unicode directional quotes are used are used where available
51
  (currently, UTF-8 locales on Unix-alikes and all Windows locales
53
  (currently, UTF-8 locales on Unix-alikes and all Windows locales
52
  except \code{C}): if set to \code{"UTF-8"} UTF-8 markup is used
54
  except \code{C}): if set to \code{"UTF-8"} UTF-8 markup is used
53
  (whatever the current locale). If set to \code{"TeX"}, TeX-style
55
  (whatever the current locale). If set to \code{"TeX"}, TeX-style