Fixes to the .Rd files in order to pass the checks for CRAN submission.

.Rbuildignore

@@ -1,4 +1,6 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
 \.gitignore$
-installR.Rproj
+installR.Rproj
+\.RData$
+\.Rhistory$

DESCRIPTION

@@ -7,21 +7,25 @@ Date: 2013-03-29
 Author: Tal Galili
 Maintainer: Tal Galili <tal.galili@gmail.com>
 Description: The 'installr' package aims at making the process of updating R on
-    Windows as easy as possible. Also, the package contains a (growing) set of functions for allowing
-    users to install new software (on Windows OS) using R. By simply running the installr() function,
-    the user can easily select (via a GUI interface) a software to install. There are also dedicated functions
-    for installing each software, such as: updateR(), install.RTools(), install.pandoc(), and many more.    
-    While for Linux users, the installation process of new software may be just running a short
-    line of code, for the regular Windows user it often includes browsing 
-    online, finding the latest version, downloading it, running the installer,
-    and deleting the installation file. All of these steps are automatically
-    done using functions in this package.
+    Windows as easy as possible. Also, the package contains a (growing) set of
+    functions for allowing users to install new software (on Windows OS) using
+    R. By simply running the installr() function, the user can easily select
+    (via a GUI interface) a software to install. There are also dedicated
+    functions for installing each software, such as: updateR(),
+    install.RTools(), install.pandoc(), and many more. While for Linux users,
+    the installation process of new software may be just running a short line
+    of code, for the regular Windows user it often includes browsing online,
+    finding the latest version, downloading it, running the installer, and
+    deleting the installation file. All of these steps are automatically done
+    using functions in this package.
 URL: https://github.com/talgalili/installr
 BugReports: https://github.com/talgalili/installr/issues
 Depends:
     R (>= 2.11.0)
 Suggests:
-    XML, devtools
+    XML,
+    devtools,
+    tools
 License: GPL-2
 Collate:
     'create.global.library.r'

NAMESPACE

@@ -5,38 +5,38 @@ export(create.global.library)
 export(file.name.from.url)
 export(get.installed.R.folders)
 export(install.7zip)
-export(install.cygwin)
 export(install.Cygwin)
-export(install.ffmpeg)
 export(install.FFmpeg)
+export(install.GitHub)
+export(install.GraphicsMagick)
+export(install.ImageMagick)
+export(install.LaTeX2RTF)
+export(install.LyX)
+export(install.MikTeX)
+export(install.R)
+export(install.RStudio)
+export(install.Rtools)
+export(install.SWFTools)
+export(install.URL)
+export(install.cygwin)
+export(install.ffmpeg)
 export(install.git)
 export(install.github)
-export(install.GitHub)
 export(install.graphicsmagick)
-export(install.GraphicsMagick)
 export(install.imagemagick)
-export(install.ImageMagick)
 export(install.latex2rtf)
-export(install.LaTeX2RTF)
 export(install.lyx)
-export(install.LyX)
 export(install.miktex)
-export(install.MikTeX)
 export(install.notepadpp)
 export(install.npptor)
 export(install.packages.zip)
 export(install.pandoc)
-export(install.R)
 export(install.rstudio)
-export(install.RStudio)
 export(install.rtools)
-export(install.Rtools)
 export(install.swftools)
-export(install.SWFTools)
-export(install.URL)
 export(installr)
-export(is.Rgui)
 export(is.RStudio)
+export(is.Rgui)
 export(is.windows)
 export(os.hibernate)
 export(os.lock)

NEWS

@@ -5,7 +5,8 @@ UPDATED FUNCTIONS:
    * Made sure to include a lower-case version of all install.X functions.
 
 OTHER NOTES:
-   * More documentation.  Updated README.md (fixed \link vs \url)
+   * More documentation.  Updated README.md
+   * installR 0.9 is to be shiped to CRAN.
 
 
 
@@ -84,6 +85,7 @@ FIXES FOR CRAN SUBMISSION:
    * Fixed some spelling mistakes in DESCRIPTION,
    * Made sure to run the checks in the latest R version (R 2.15.3, oh the irony)
    * Changed update.R to be called updateR (in order to avoid confusing it as an S3 variation to 'update')
+   * installR 0.8 is to be shiped to CRAN.
 
 
 My thanks goes to Prof Brian Ripley for his help.
@@ -102,8 +104,6 @@ UPDATED FUNCTIONS:
 
 OTHER NOTES:
    * More documentation.  Updated README.md (fixed \link vs \url)
-   * More documentation.  Updated README.md
-
 
 installR 0.6
 ------------

R/install.r

@@ -630,7 +630,7 @@ install.rstudio <- function(...) install.RStudio(...)
 #' @aliases install.imagemagick
 #' @description Allows the user to downloads and install the latest version of ImageMagick for Windows.
 #' @details
-#' ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 100) including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.
+#' ImageMagick is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 100) including DPX, EXR, GIF, JPEG, JPEG-2000, PDF, PhotoCD, PNG, Postscript, SVG, and TIFF. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bezier curves.
 #' This function downloads Win32 dynamic at 16 bits-per-pixel.
 #' @param page_with_download_url the URL of the ImageMagick download page.
 #' @param ... extra parameters to pass to \link{install.URL}
@@ -860,16 +860,16 @@ install.7zip  <- function(page_with_download_url="http://www.7-zip.org/download.
 
 
 # 
-# #' @title Unzips a file using 7z
-# #' @param page_with_download_url the URL of the FFmpeg download page.
-# #' @param ... NOT used
-# #' @return the shell output of 7z
-# #' @references
-# #' \url{http://stackoverflow.com/questions/14122732/unzip-files-7-zip-via-cmd-command}
-# #' @examples
-# #' \dontrun{
-# #' 
-# #' }
+# # ' @title Unzips a file using 7z
+# # ' @param page_with_download_url the URL of the FFmpeg download page.
+# # ' @param ... NOT used
+# # ' @return the shell output of 7z
+# # ' @references
+# # ' \url{http://stackoverflow.com/questions/14122732/unzip-files-7-zip-via-cmd-command}
+# # ' @examples
+# # ' \dontrun{
+# # ' 
+# # ' }
 # un7zip <- function(zip_file, the_7zip_path = "C:\\Program Files (x86)\\7-Zip\\",...)
 # {
 #    shell(paste("'",the_7zip_path,"7z.exe' -x '", a_7z_filename, "'", sep = ""), intern = TRUE, translate = TRUE)
@@ -919,10 +919,10 @@ install.ffmpeg <- function(...) install.FFmpeg(...)
 #' @title Returns the search path for executable files
 #' @export
 #' @description Returns the search path for executable files based on %PATH%
-#' @param NONE
 #' @return A character vector with the search path for executable files
 #' @references
-#' \url{http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/ntcmds_shelloverview.mspx?mfr=true}#' @examples
+#' \url{http://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/ntcmds_shelloverview.mspx?mfr=true}
+#' @examples
 #' \dontrun{
 #' system.PATH() # 
 #' }
@@ -932,13 +932,14 @@ system.PATH <- function() strsplit(shell("echo %PATH% ", intern= TRUE), ";")[[1]
 #' @description Checks the existence of an .exe extention in the search path for executable files
 #' @param exe_file a character with the name of the 
 #' @return A boolean vector indication the existence of each program on the system.
+#' @examples
 #' \dontrun{
-#' is.exe.installed(c("zip.exe", "Rgui.exe", "blablabla")) # [1]  TRUE  TRUE FALSE#' 
+#' is.exe.installed(c("zip.exe", "Rgui.exe", "blablabla")) # [1]  TRUE  TRUE FALSE
 #' is.exe.installed("7z") 
 #' }
 is.exe.installed <- function(exe_file) {
    all_installed_exe <- list.files(system.PATH())
-   exe_file %in% installed_exe
+   exe_file %in% all_installed_exe
 }
 
 # ' @title Extends the current path with more possible softwares

R/os.manage.r

@@ -85,7 +85,7 @@ os.sleep <- function(s=0, m=0, h=0, first_turn_hibernate_off = TRUE) {
 #' @param s time to wait before shutting down (in seconds), added to m and h; passed to \code{\link[base]{Sys.sleep}}
 #' @param m time to wait before shutting down (in minutes), added to s and h; passed to \code{\link[base]{Sys.sleep}}
 #' @param h time to wait before shutting down (in hours), added to s and m; passed to \code{\link[base]{Sys.sleep}}
-#' @param first_turn_hibernate_on
+#' @param first_turn_hibernate_on default is TRUE. This runs "powercfg -hibernate on" in order to turn hibernate on, in cases where it was off.
 #' @return The status code of \code{\link[base]{shell}}.
 #' @author Tal Galili
 #' @seealso \code{\link[base]{system}},\code{\link[base]{shell}}, \code{\link[base]{Sys.sleep}},