[R-gregmisc-users] SF.net SVN: r-gregmisc: [1278] trunk/gtools/man/checkRVersion.Rd

[<wa...@us...>]

Revision: 1278
          http://r-gregmisc.svn.sourceforge.net/r-gregmisc/?rev=1278&view=rev
Author:   warnes
Date:     2008-05-22 09:17:22 -0700 (Thu, 22 May 2008)

Log Message:
-----------
Add man page for checkRVersion

Added Paths:
-----------
    trunk/gtools/man/checkRVersion.Rd

Added: trunk/gtools/man/checkRVersion.Rd
===================================================================
--- trunk/gtools/man/checkRVersion.Rd	                        (rev 0)
+++ trunk/gtools/man/checkRVersion.Rd	2008-05-22 16:17:22 UTC (rev 1278)
@@ -0,0 +1,44 @@
+\name{checkRVersion}
+\alias{checkRVersion}
+\title{Check if a newer version of R is available}
+\description{
+  Check if a newer version of R is available
+}
+\usage{
+checkRVersion(quiet = FALSE)
+}
+\arguments{
+  \item{quiet}{Logical indicating whether printed output should be supressed.}
+}
+\details{
+  This function accesses the R web site to discover the latest released
+  version of R.  It then compares this version to the running version.
+  If the running version is the same as the latest version, it prints
+  the message, "The latest version of R is installed:" followed by the
+  version number, and returns NULL.  If the running version is older
+  than the current version, it displays the message, "A newer version of
+  R is now available:" followed by the corresponding version number, and
+  returns the version number.
+
+  If \code{quiet=TRUE}, no printing is performed.
+  
+}
+\value{
+  Either the version number of the latest version of R, if the running
+  version is less than the latest version, or NULL.
+}
+\author{Gregory R. Warnes \email{gre...@ro...>}}
+\note{
+    This function utilizes the internet to access the R project web
+    site.  If internet access is unavailable, the function will fail.
+}
+\seealso{ \code{\link[base]{R.Version}} }
+\examples{
+
+checkRVersion()
+
+ver <- checkRVersion()
+print(ver)
+
+}
+\keyword{utilities}


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.