From a.stephenson@lancaster.ac.uk  Tue Oct 29 11:20:11 2002
From: a.stephenson@lancaster.ac.uk (a.stephenson@lancaster.ac.uk)
Date: Tue, 29 Oct 2002 12:20:11 +0100 (MET)
Subject: documentation for require (PR#2226)
Message-ID: <200210291120.MAA04954@pubhealth.ku.dk>

Full_Name: alec stephenson
Version: 1.6.0
OS: linux
Submission from: (NULL) (148.88.138.5)


The documentation for the function require is incorrect.

The file library.Rd has in its arguments section

  \item{quietly}{a logical.  If \code{TRUE}, a warning will not be
      printed if the package cannot be found.}

which is incorrect, as a warning message is always given if the package 
is not found.
Should be something like

  \item{quietly}{a logical.  If \code{TRUE}, a message confirming
      package loading is not printed.}

also, the details section has

  \code{require} is designed for use
  inside other functions; it returns \code{FALSE} and optionally gives a
  warning, rather than giving an error, if the package does not exist.

The sentence after the semi-colon is also appears to be incorrect, as
require calls library with logical.return = TRUE.
Should be something like 

  \code{require} is designed for use
  inside other functions; it returns \code{FALSE} and gives a warning
  if the package does not exist.



> version
         _                
platform i686-pc-linux-gnu
arch     i686             
os       linux-gnu        
system   i686, linux-gnu  
status                    
major    1                
minor    6.0              
year     2002             
month    10               
day      01               
language R 

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._


documentation for require (PR#2226)
a.stephenson@lancaster.ac.uk