[Soiltexture-commits] r109 - / pkg/soiltexture/man

[noreply at r-forge.r-project.org]

Author: jmoeys
Date: 2014-07-03 14:34:15 +0200 (Thu, 03 Jul 2014)
New Revision: 109

Added:
   pkg/soiltexture/man/soiltextureInfo.Rd
Modified:
   soiltexture_1_RCMDBUILD.bat
   soiltexture_2_RCMDcheck_noexamples.bat
   soiltexture_3_RCMDINSTALL_build.BAT
   soiltexture_compile.R
Log:
doc, etc

Added: pkg/soiltexture/man/soiltextureInfo.Rd
===================================================================
--- pkg/soiltexture/man/soiltextureInfo.Rd	                        (rev 0)
+++ pkg/soiltexture/man/soiltextureInfo.Rd	2014-07-03 12:34:15 UTC (rev 109)
@@ -0,0 +1,108 @@
+\name{soiltextureInfo}
+
+\alias{soiltextureInfo}
+
+\title{Display and / or export system and package version information}
+
+\description{Display and / or export system and package version information. 
+
+Can be used to provide an overview of the system and the R 
+
+packages that were used to produce some calculations, thus 
+
+improving the traceability of that work in the long run.}
+
+\usage{soiltextureInfo(file = NULL, verbose = TRUE, depends = FALSE, 
+
+    md5 = TRUE, packages = "soiltexture")}
+
+\arguments{
+
+  \item{file}{Single character string. Name of the text file (with or without 
+
+its path) in which the information will be exported. If 
+
+\code{NULL} (default), information are not exported.}
+
+  \item{verbose}{Single logical value. If \code{TRUE}, information are displayed 
+
+on the screen.}
+
+  \item{depends}{Single logical value. If \code{TRUE}, information on packages 
+
+dependencies are also displayed, in the same way}
+
+  \item{md5}{Single logical value. If \code{TRUE}, the package MD5 checksums 
+
+are returned too}
+
+  \item{packages}{Single character string. Name of the package whose information 
+
+must be returned.}
+
+}
+
+
+
+\value{Invisibly returns the information as a vector of character 
+
+strings}
+
+
+
+\author{Julien MOEYS <jules_m78-soiltexture at yahoo.fr>, contributions from Wei Shangguan.}
+
+
+
+
+
+
+
+\seealso{The base functions that were used internally to compile 
+
+the information: \code{\link[base]{Sys.time}}, 
+
+\code{\link[base]{Sys.info}}, \code{\link[base]{version}}, 
+
+\code{\link[base]{.packages}}, 
+
+\code{\link[utils]{installed.packages}}, 
+
+\code{\link[tools]{package_dependencies}}. See also the 
+
+\code{MD5} file in each package directory (and 
+
+\code{\link[tools]{md5sum}} for generating these MD5 checksums).}
+
+\examples{
+
+library( "soiltexture" )
+
+
+
+#   Temporary file where the info will be exported:
+
+f <- tempfile() 
+
+
+
+#   Generate package information
+
+soiltextureInfo( file = f, depends = TRUE, verbose = FALSE )
+
+
+
+#   Read again the info (as for verbose = TRUE)
+
+cat( readLines( f ), sep = "\n" ) 
+
+unlink( f )
+
+
+
+#   Also works with other packages
+
+soiltextureInfo( packages = "sp" )
+
+}
+

Modified: soiltexture_1_RCMDBUILD.bat
===================================================================
--- soiltexture_1_RCMDBUILD.bat	2014-07-03 12:32:47 UTC (rev 108)
+++ soiltexture_1_RCMDBUILD.bat	2014-07-03 12:34:15 UTC (rev 109)
@@ -2,7 +2,7 @@
 
 cd /D "%rPackagesDir%\%pkgname%\pkg" 
 
-svnversion > %pkgname%\SVN_VERSION
+svnversion > %pkgname%\inst\SVN_VERSION
 
 R CMD build --compact-vignettes="gs+qpdf" --md5 %pkgname% 
 

Modified: soiltexture_2_RCMDcheck_noexamples.bat
===================================================================
--- soiltexture_2_RCMDcheck_noexamples.bat	2014-07-03 12:32:47 UTC (rev 108)
+++ soiltexture_2_RCMDcheck_noexamples.bat	2014-07-03 12:34:15 UTC (rev 109)
@@ -1,5 +1,5 @@
 set pkgname=soiltexture
-set version=1.2.16
+set version=1.2.18
 
 cd /D "%rPackagesDir%\%pkgname%\pkg" 
 

Modified: soiltexture_3_RCMDINSTALL_build.BAT
===================================================================
--- soiltexture_3_RCMDINSTALL_build.BAT	2014-07-03 12:32:47 UTC (rev 108)
+++ soiltexture_3_RCMDINSTALL_build.BAT	2014-07-03 12:34:15 UTC (rev 109)
@@ -1,5 +1,5 @@
 set pkgname=soiltexture
-set version=1.2.16
+set version=1.2.18
 
 cd /D "%rPackagesDir%\%pkgname%\pkg" 
 

Modified: soiltexture_compile.R
===================================================================
--- soiltexture_compile.R	2014-07-03 12:32:47 UTC (rev 108)
+++ soiltexture_compile.R	2014-07-03 12:34:15 UTC (rev 109)
@@ -18,7 +18,7 @@
 pkgDescription( 
     pkgName     = pkgName, 
     pkgDir      = pkgDir, 
-    pkgVersion  = "1.2.16", 
+    pkgVersion  = "1.2.18", 
     pkgDepends  = c( "sp","MASS" ), 
     pkgSuggests = "xtable", # c("drc","plotrix"), 
     RVersion    = NULL