Skip to content

Commit d62268a

Browse files
author
hornik
committed
Add and use 'I' macros for marking up text spelled ok 'as is'
and hence safely to be ignored for spell checking. git-svn-id: https://svn.r-project.org/R/trunk@85806 00db46b3-68df-0310-9c12-caf00c1e9a41
1 parent 50d2f73 commit d62268a

File tree

11 files changed

+664
-574
lines changed

11 files changed

+664
-574
lines changed

doc/manual/R-FAQ.texi

Lines changed: 160 additions & 113 deletions
Large diffs are not rendered by default.

doc/manual/R-admin.texi

Lines changed: 147 additions & 145 deletions
Large diffs are not rendered by default.

doc/manual/R-data.texi

Lines changed: 97 additions & 78 deletions
Large diffs are not rendered by default.

doc/manual/R-defs.texi

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ except that this permission notice may be stated in a translation
6363
approved by the R Core Team.
6464
@end macro
6565
66+
@macro I{s}
67+
\s\
68+
@end macro
69+
6670
@c This breaks HTML conversion on texinfo 4.x.
6771
@iftex
6872
@hyphenation{name-space name-spaces}

doc/manual/R-exts.texi

Lines changed: 146 additions & 146 deletions
Large diffs are not rendered by default.

doc/manual/R-intro.texi

Lines changed: 54 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ statistical modelling and graphics.
114114

115115
This introduction to @R{} is derived from an original set of notes
116116
describing the @Sl{} and @SPLUS{} environments written in 1990--2 by
117-
Bill Venables and David M. Smith when at the University of Adelaide. We
118-
have made a number of small changes to reflect differences between the
119-
@R{} and @Sl{} programs, and expanded some of the material.
117+
@I{Bill Venables} and @I{David M. Smith} when at the University of
118+
Adelaide. We have made a number of small changes to reflect differences
119+
between the @R{} and @Sl{} programs, and expanded some of the material.
120120

121-
We would like to extend warm thanks to Bill Venables (and David Smith)
122-
for granting permission to distribute this modified version of the notes
123-
in this way, and for being a supporter of @R{} from way back.
121+
We would like to extend warm thanks to @I{Bill Venables} (and @I{David
122+
Smith}) for granting permission to distribute this modified version of
123+
the notes in this way, and for being a supporter of @R{} from way back.
124124

125125
Comments and corrections are always welcome. Please address email
126126
correspondence to @email{R-help@@R-project.org}.
@@ -195,19 +195,19 @@ analysis.
195195
@section Related software and documentation
196196

197197
@R{} can be regarded as an implementation of the @Sl{} language which
198-
was developed at Bell Laboratories by Rick Becker, John Chambers and
199-
Allan Wilks, and also forms the basis of the @SPLUS{} systems.
198+
was developed at Bell Laboratories by @I{Rick Becker}, @I{John Chambers}
199+
and @I{Allan Wilks}, and also forms the basis of the @SPLUS{} systems.
200200

201201
The evolution of the @Sl{} language is characterized by four books by
202202
John Chambers and coauthors. For @R{}, the basic reference is @emph{The
203203
New @Sl{} Language: A Programming Environment for Data Analysis and
204-
Graphics} by Richard A.@: Becker, John M.@: Chambers and Allan R.@:
205-
Wilks. The new features of the 1991 release of @Sl{}
204+
Graphics} by @I{Richard A.@: Becker}, @I{John M.@: Chambers} and
205+
@I{Allan R.@: Wilks}. The new features of the 1991 release of @Sl{}
206206
@c (@Sl{} version 3) JMC says the 1988 version is S3.
207-
are covered in @emph{Statistical Models in @Sl{}} edited by John M.@:
208-
Chambers and Trevor J.@: Hastie. The formal methods and classes of the
207+
are covered in @emph{Statistical Models in @Sl{}} edited by @I{John M.@:
208+
Chambers} and @I{Trevor J.@: Hastie}. The formal methods and classes of the
209209
@pkg{methods} package are based on those described in @emph{Programming
210-
with Data} by John M.@: Chambers. @xref{References}, for precise
210+
with Data} by @I{John M.@: Chambers}. @xref{References}, for precise
211211
references.
212212

213213
There are now a number of books which describe how to use @R{} for data
@@ -456,7 +456,7 @@ newline. Elementary commands can be grouped together into one compound
456456
expression by braces (@samp{@code{@{}} and @samp{@code{@}}}).
457457
@emph{Comments} can be put almost@footnote{@strong{not} inside strings,
458458
nor within the argument list of a function definition} anywhere,
459-
starting with a hashmark (@samp{@code{#}}), everything to the end of the
459+
starting with a hash mark (@samp{@code{#}}), everything to the end of the
460460
line is a comment.
461461

462462
If a command is not complete at the end of a line, @R{} will
@@ -3170,7 +3170,7 @@ qqline(x)
31703170
@end example
31713171

31723172
Finally, we might want a more formal test of agreement with normality
3173-
(or not). @R{} provides the Shapiro-Wilk test
3173+
(or not). @R{} provides the Shapiro-@I{Wilk} test
31743174
@cindex Shapiro-Wilk test
31753175
@findex shapiro.test
31763176

@@ -4389,7 +4389,7 @@ explicitly removed.
43894389
@end table
43904390

43914391
The @emph{formula operators} are similar in effect to the Wilkinson and
4392-
Rogers notation used by such programs as Glim and Genstat. One
4392+
Rogers notation used by such programs as @I{Glim} and Genstat. One
43934393
inevitable change is that the operator @samp{@code{.}} becomes
43944394
@samp{@code{:}} since the period is a valid name character in @R{}.
43954395

@@ -4825,8 +4825,8 @@ These assumptions are loose enough to encompass a wide class of models
48254825
useful in statistical practice, but tight enough to allow the
48264826
development of a unified methodology of estimation and inference, at
48274827
least approximately. The reader is referred to any of the current
4828-
reference works on the subject for full details, such as McCullagh &
4829-
Nelder (1989) or Dobson (1990).
4828+
reference works on the subject for full details, such as @I{McCullagh &
4829+
Nelder} (1989) or @I{Dobson} (1990).
48304830

48314831
@menu
48324832
* Families::
@@ -4921,7 +4921,7 @@ we shall see later.
49214921

49224922
@subsubheading The @code{binomial} family
49234923

4924-
Consider a small, artificial example, from Silvey (1970).
4924+
Consider a small, artificial example, from @I{Silvey} (1970).
49254925

49264926
On the Aegean island of Kalythos the male inhabitants suffer from a
49274927
congenital eye disease, the effects of which become more marked with
@@ -5190,7 +5190,7 @@ fit on a new plot:
51905190

51915191
The standard package @pkg{stats} provides much more extensive facilities
51925192
for fitting non-linear models by least squares. The model we have just
5193-
fitted is the Michaelis-Menten model, so we can use
5193+
fitted is the @I{Michaelis}-@I{Menten} model, so we can use
51945194

51955195
@example
51965196
> df <- data.frame(x=x, y=y)
@@ -5225,7 +5225,7 @@ K 0.7651
52255225
Maximum likelihood is a method of nonlinear model fitting that applies
52265226
even if the errors are not normal. The method finds the parameter values
52275227
which maximize the log likelihood, or equivalently which minimize the
5228-
negative log-likelihood. Here is an example from Dobson (1990), pp.@:
5228+
negative log-likelihood. Here is an example from @I{Dobson} (1990), pp.@:
52295229
108--111. This example fits a logistic model to dose-response data,
52305230
which clearly could also be fit by @code{glm()}. The data are:
52315231

@@ -6416,8 +6416,8 @@ Terminate all graphics devices on the list, except the null device.
64166416
@R{} does not have builtin capabilities for dynamic or
64176417
interactive graphics, e.g.@: rotating point clouds or to ``brushing''
64186418
(interactively highlighting) points. However, extensive dynamic graphics
6419-
facilities are available in the system GGobi by Swayne, Cook and Buja
6420-
available from
6419+
facilities are available in the system @I{GGobi} by @I{Swayne}, @I{Cook}
6420+
and @I{Buja} available from
64216421

64226422
@quotation
64236423
@uref{http://ggobi.org/}
@@ -6456,7 +6456,7 @@ To see which packages are installed at your site, issue the command
64566456

64576457
@noindent
64586458
with no arguments. To load a particular package (e.g., the @CRANpkg{boot}
6459-
package containing functions from Davison & Hinkley (1997)), use a
6459+
package containing functions from @I{Davison} & @I{Hinkley} (1997)), use a
64606460
command like
64616461

64626462
@example
@@ -7490,7 +7490,7 @@ to their path), use
74907490
@end example
74917491

74927492
@noindent
7493-
At least in Bourne and bash shells, the @code{#!} mechanism does
7493+
At least in @I{Bourne} and bash shells, the @code{#!} mechanism does
74947494
@strong{not} allow extra arguments like
74957495
@code{#! /usr/bin/env Rscript --vanilla}.
74967496

@@ -7508,8 +7508,8 @@ and @code{stdin()} refers to the script file to allow such traditional
75087508
usage. If you want to refer to the process's @file{stdin}, use
75097509
@code{"stdin"} as a @code{file} connection, e.g.@: @code{scan("stdin", ...)}.
75107510

7511-
Another way to write executable script files (suggested by Fran@,{c}ois
7512-
Pinard) is to use a @emph{here document} like
7511+
Another way to write executable script files (suggested by
7512+
@I{Fran@,{c}ois Pinard}) is to use a @emph{here document} like
75137513

75147514
@example
75157515
#!/bin/sh
@@ -7689,41 +7689,51 @@ $endif
76897689
@node References, , Concept index, Top
76907690
@appendix References
76917691

7692-
D.@: M.@: Bates and D.@: G.@: Watts (1988), @emph{Nonlinear Regression
7693-
Analysis and Its Applications.} John Wiley & Sons, New York.
7692+
@I{D.@: M.@: Bates} and @I{D.@: G.@: Watts} (1988),
7693+
@emph{Nonlinear Regression Analysis and Its Applications.}
7694+
John Wiley & Sons, New York.
76947695

76957696
@noindent
7696-
Richard A.@: Becker, John M.@: Chambers and Allan R.@: Wilks (1988),
7697-
@emph{The New S Language.} Chapman & Hall, New York.
7697+
@I{Richard A.@: Becker}, @I{John M.@: Chambers} and @I{Allan R.@: Wilks} (1988),
7698+
@emph{The New S Language.}
7699+
Chapman & Hall, New York.
76987700
This book is often called the ``@emph{Blue Book}''.
76997701

77007702
@noindent
7701-
John M.@: Chambers and Trevor J.@: Hastie eds. (1992),
7702-
@emph{Statistical Models in S.} Chapman & Hall, New York.
7703+
@I{John M.@: Chambers} and @I{Trevor J.@: Hastie} eds. (1992),
7704+
@emph{Statistical Models in S.}
7705+
Chapman & Hall, New York.
77037706
This is also called the ``@emph{White Book}''.
77047707

77057708
@noindent
7706-
John M.@: Chambers (1998)
7707-
@emph{Programming with Data}. Springer, New York.
7709+
@I{John M.@: Chambers} (1998)
7710+
@emph{Programming with Data}.
7711+
@I{Springer}, New York.
77087712
This is also called the ``@emph{Green Book}''.
77097713

77107714
@noindent
7711-
A.@: C.@: Davison and D.@: V.@: Hinkley (1997), @emph{Bootstrap Methods
7712-
and Their Applications}, Cambridge University Press.
7715+
@I{A.@: C.@: Davison} and @I{D.@: V.@: Hinkley} (1997),
7716+
@emph{Bootstrap Methods and Their Applications},
7717+
Cambridge University Press.
77137718

77147719
@noindent
7715-
Annette J.@: Dobson (1990), @emph{An Introduction to Generalized Linear
7716-
Models}, Chapman and Hall, London.
7720+
@I{Annette J.@: Dobson} (1990),
7721+
@emph{An Introduction to Generalized Linear Models},
7722+
Chapman and Hall, London.
77177723

77187724
@noindent
7719-
Peter McCullagh and John A.@: Nelder (1989), @emph{Generalized Linear
7720-
Models.} Second edition, Chapman and Hall, London.
7725+
@I{Peter McCullagh} and @I{John A.@: Nelder} (1989),
7726+
@emph{Generalized Linear Models.}
7727+
Second edition, Chapman and Hall, London.
77217728

77227729
@noindent
7723-
John A.@ Rice (1995), @emph{Mathematical Statistics and Data Analysis.}
7724-
Second edition. Duxbury Press, Belmont, CA.
7730+
@I{John A.@ Rice} (1995),
7731+
@emph{Mathematical Statistics and Data Analysis.}
7732+
Second edition. @I{Duxbury Press}, Belmont, CA.
77257733

77267734
@noindent
7727-
S.@: D.@: Silvey (1970), @emph{Statistical Inference.} Penguin, London.
7735+
@I{S.@: D.@: Silvey} (1970),
7736+
@emph{Statistical Inference.}
7737+
Penguin, London.
77287738

77297739
@bye

0 commit comments

Comments
 (0)