macroutilsInfo {macroutils}R Documentation

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

macroutilsInfo(file = NULL, verbose = TRUE, depends = FALSE, md5 = TRUE,
  packages = "macroutils")

Arguments

file

Single character string. Name of the text file (with or without its path) in which the information will be exported. If NULL (default), information are not exported.

verbose

Single logical value. If TRUE, information are displayed on the screen.

depends

Single logical value. If TRUE, information on packages dependencies are also displayed, in the same way

md5

Single logical value. If TRUE, the package MD5 checksums are returned too

packages

Single character string. Name of the package whose information must be returned.

Value

Invisibly returns the information as a vector of character strings

See Also

The base functions that were used internally to compile the information: Sys.time, Sys.info, version, .packages, installed.packages, package_dependencies. See also the MD5 file in each package directory (and md5sum for generating these MD5 checksums).

Examples

library( "macroutils" )

#   Temporary file where the info will be exported:
f <- tempfile() 

#   Generate package information
macroutilsInfo( file = f, depends = TRUE, verbose = FALSE )

#   Read again the info (as for verbose = TRUE)
cat( readLines( f ), sep = "\n" ) 
## INFORMATION ON SYSTEM AND PACKAGE(S) VERSION(S)
## ===============================================
## 
## Date and time: 2015-04-17 16:50:13
## 
## System info and R version
## -------------------------
## 
## System info:
##             info                      value
## 1        sysname                    Windows
## 2        release                      7 x64
## 3        version build 7601, Service Pack 1
## 4       nodename               ************
## 5        machine                        x86
## 6          login                    *******
## 7           user                    *******
## 8 effective_user                    *******
## 
## R version:
##              info                                  value
## 1        platform                       i386-w64-mingw32
## 2            arch                                   i386
## 3              os                                mingw32
## 4          system                          i386, mingw32
## 5          status                                     RC
## 6           major                                      3
## 7           minor                                    2.0
## 8            year                                   2015
## 9           month                                     04
## 10            day                                     15
## 11        svn rev                                  68178
## 12       language                                      R
## 13 version.string R version 3.2.0 RC (2015-04-15 r68178)
## 14       nickname                    Full of Ingredients
## 
## Loaded packages:
##      package version
## 1       base   3.2.0
## 2   datasets   3.2.0
## 3   graphics   3.2.0
## 4  grDevices   3.2.0
## 5      knitr     1.9
## 6 macroutils   1.8.2
## 7    methods   3.2.0
## 8      stats   3.2.0
## 9      utils   3.2.0
## 
## Information for packages: macroutils
## 
## Dependencies (except base packages): none
## 
## Package information for macroutils
## -----------------------
## 
## Package version: 1.8.2
## 
## SVN revision: 18:52M
## 
## Package MD5: C:/Users/*******/Documents/R/win-library/3.2/macroutils/MD5
## 
## 9997da676a70fa46f18b844a9077d449 *DESCRIPTION
## 27ea667b4212922eb20dcc4bab41f73f *GIT_VERSION
## aad2a0719227bd34e13f57f4055fe37c *INDEX
## 5655d86506dd3b2a09e287292baa3c1f *Meta/Rd.rds
## e7259d1be655678048e95ef55ef8d378 *Meta/hsearch.rds
## aee2a0d89d30e223b1d4e1748a04599b *Meta/links.rds
## 22526bc26793f974aa4d55a0d306d9b8 *Meta/nsInfo.rds
## 079958f0e9ffe0e6187c49d3235c8b16 *Meta/package.rds
## c35aaf061d7feadbce5db1495a1b9768 *Meta/vignette.rds
## dfbd7869a6b9368478b3b06f987ee59e *NAMESPACE
## 061e98d941b7bc5b8721b41a5d8f34d6 *NEWS
## ebf0fc819595d631b8bf280c4b049940 *R/macroutils
## 27fe35da720825538bd6eb48e99c011c *R/macroutils.rdb
## 1cb73c7f86d0b88aeb232874e05ccc24 *R/macroutils.rdx
## d20624f431987345dc64de6a40263936 *SVN_VERSION
## 9d55845f0182e694249cdc37ba5fb91d *bintest/Fert.bin
## adcf76a000a1c78ae0f9bda8566338ea *bintest/METFILE.BIN
## 560e0acfb32ffee7e78b1f149e30919b *bintest/METFILE.TXT
## 5ac4a98c62f04e9c86bdf90bf4f0acc3 *bintest/RAINFALL.BIN
## 25b1d06d7e1f3005cf1eecfec90fc30c *bintest/RAINFALL.TXT
## b35692dbfe1021295b6015e365239201 *bintest/defaultrun.bin
## 1ac69a7ec055ee2a40207dd426e3859e *bintest/defaultrun.txt
## d763c3138f0bea180c38b28aaa6309c4 *bintest/soiln001.BIN
## aef26ec10be36dbb86ca711de04582a8 *doc/index.html
## 1101b96aa7075edf806750b0c711c70a *doc/macroutils_vignette.R
## 07d010e4223ef9acfdc45e9a11231c38 *doc/macroutils_vignette.Rnw
## fc1491bb0a3ddfa4641dc7e7af2beb35 *doc/macroutils_vignette.pdf
## 2ac32afc7405efdd04f8d002bcae6fee *examples/macroAggregateBin.R
## 9b9d1def3e70f699507018b4a3aba6f1 *examples/macroPlotBin.R
## 1b514f6644562743382e90ef35f5aa3b *examples/macroReadBin.R
## f7a6cd8ccac663121ba2e0ea0f5249de *examples/macroWriteBin.R
## cb70bc9bafc46df88bf2fd3584fa432e *examples/macroutilsInfo-examples.R
## d23643bdb59ea160295b42957b8ae4ff *help/AnIndex
## 1b329b627912cba882d9955b74278b76 *help/aliases.rds
## f29c833a6a6d520c2d24ff9f56198f4f *help/macroutils.rdb
## 2d591e8982188934abe1b987795d6761 *help/macroutils.rdx
## 72fa5941f2c801116fb6cfaabe202582 *help/paths.rds
## d33254b3df4be75a113d6d5a50603316 *html/00Index.html
## 0629445e5f3de06acbaf6e4013c7deca *html/R.css
unlink( f )

#   Also works with other packages
macroutilsInfo( packages = "tools" )
## INFORMATION ON SYSTEM AND PACKAGE(S) VERSION(S)
## ===============================================
## 
## Date and time: 2015-04-17 16:50:13
## 
## System info and R version
## -------------------------
## 
## System info:
##             info                      value
## 1        sysname                    Windows
## 2        release                      7 x64
## 3        version build 7601, Service Pack 1
## 4       nodename               ************
## 5        machine                        x86
## 6          login                    *******
## 7           user                    *******
## 8 effective_user                    *******
## 
## R version:
##              info                                  value
## 1        platform                       i386-w64-mingw32
## 2            arch                                   i386
## 3              os                                mingw32
## 4          system                          i386, mingw32
## 5          status                                     RC
## 6           major                                      3
## 7           minor                                    2.0
## 8            year                                   2015
## 9           month                                     04
## 10            day                                     15
## 11        svn rev                                  68178
## 12       language                                      R
## 13 version.string R version 3.2.0 RC (2015-04-15 r68178)
## 14       nickname                    Full of Ingredients
## 
## Loaded packages:
##      package version
## 1       base   3.2.0
## 2   datasets   3.2.0
## 3   graphics   3.2.0
## 4  grDevices   3.2.0
## 5      knitr     1.9
## 6 macroutils   1.8.2
## 7    methods   3.2.0
## 8      stats   3.2.0
## 9      utils   3.2.0
## 
## Information for packages: tools
## 
## Package information for tools
## -----------------------
## 
## Package version: 3.2.0
## 
## No MD5 checksum found

[Package macroutils version 1.8.2 Index]