From bbolker at gmail.com  Tue Sep 14 18:42:30 2010
From: bbolker at gmail.com (Ben Bolker)
Date: Tue, 14 Sep 2010 12:42:30 -0400
Subject: [Rd] doc bug in ?residuals.gls
Message-ID: <4C8FA5F6.4070304@gmail.com>


Under the description of the 'type' argument, ?residuals.gls says
'Defaults to ?"pearson"?.'

But residuals.gls starts

residuals.gls <-
function(object, type = c("response", "pearson", "normalized"), ...)
{
type <- match.arg(type)

...

which sure looks to me like it defaults to "response", not "pearson"
(and it behaves that way in tests).

It would seem to make more sense to change the documentation rather than
the code
since anyone who looked at the docs would have been confused already,
whereas someone who had
been happily using the code without looking at the docs would see a
sudden change in the results ...

This is in nlme 3.1-96, from a fresh tools/rsync-recommended. Sending it
to r-devel for comment because r-core is listed as the maintainer.

sincerely
Ben Bolker



[Rd] doc bug in ?residuals.gls
Ben Bolker