Merge pull request #139 from ShotaOchi/dev_ochi

latest version submitted to CRAN

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: imager
 Type: Package
 Title: Image Processing Library Based on 'CImg'
-Version: 0.42.1
+Version: 0.42.7
 Author: Simon Barthelme [aut], David Tschumperle [ctb], Jan Wijffels [ctb], Haz Edine Assemlal [ctb], Shota Ochi [cre]
 Authors@R: c(person("Simon","Barthelme",email="[email protected]",role=c("aut")),
  person("David","Tschumperle",role=c("ctb")),
@@ -20,14 +20,14 @@ Imports:
     Rcpp (>= 0.11.5),methods,stringr,png,jpeg,readbitmap,grDevices,purrr,downloader,igraph
 Depends:
     R (>= 2.10.0),magrittr
-URL: http://dahtah.github.io/imager, https://github.com/dahtah/imager
+URL: http://dahtah.github.io/imager/, https://github.com/dahtah/imager/
 BugReports: https://github.com/dahtah/imager/issues
-SystemRequirements: fftw3,libtiff,C++11
+SystemRequirements: fftw3,libtiff,C++11,X11
 LinkingTo: Rcpp
 LazyData: true
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 Suggests:
     knitr,
     rmarkdown,ggplot2,dplyr,scales,
-    testthat,OpenMPController,raster,spatstat, magick,Cairo
+    testthat,OpenMPController,raster,spatstat,magick,Cairo
 VignetteBuilder: knitr

R/RcppExports.R

@@ -147,7 +147,7 @@ display_list <- function(imlist) {
 
 #' Play a video 
 #'
-#' A very basic video player. Press the space bar to pause and ESC to close. 
+#' A very basic video player. Press the space bar to pause and ESC to close. Note that you need X11 library to use this function.
 #' @param vid A cimg object, to be played as video
 #' @param loop loop the video (default false)
 #' @param delay delay between frames, in ms. Default 30.

R/cimg_class.R

@@ -932,7 +932,7 @@ NULL
 
 #' Display image using CImg library
 #'
-#' Press escape or close the window to exit.
+#' Press escape or close the window to exit. Note that you need X11 library to use this function.
 #'
 #' @param x an image (cimg object)
 #' @param rescale if true pixel values are rescaled to [0-1] (default TRUE)
@@ -951,7 +951,7 @@ display.cimg <- function(x,...,rescale=TRUE)
 
 ##' Display object using CImg library
 ##'
-##' CImg has its own functions for fast, interactive image plotting. Use this if you get frustrated with slow rendering in RStudio.
+##' CImg has its own functions for fast, interactive image plotting. Use this if you get frustrated with slow rendering in RStudio. Note that you need X11 library to use this function.
 ##' @param x an image or a list of images
 ##' @param ... ignored
 ##' @seealso display.cimg, display.imlist

R/interactive.R

@@ -5,6 +5,7 @@
 ##' These functions let you select a shape in an image (a point, a line, or a rectangle)
 ##' They either return the coordinates of the shape (default), or the contents.
 ##' In case of lines contents are interpolated. Note that grabLine does not support the "pixset" return type. 
+##' Note that you need X11 library to use these functions.
 ##' @name grab
 ##' @param im an image
 ##' @param output one of "im","pixset","coord","value". Default "coord"
@@ -135,6 +136,7 @@ grabPoint <- function(im,output="coord")
 ##' You can exit the interface at any time by pressing Esc.
 ##' See examples for more.
 ##' This feature is experimental!!!
+##' Note that you need X11 library to use this function.
 ##' @param fun a function that takes a single argument (a list of user events) and returns an image to be plotted. The image won't be rescaled before plotting, so make sure RGB values are in [0,1]. 
 ##' @param title a title for the window (default "", none)
 ##' @param init initial image to display (optional)

R/utils.R

@@ -79,7 +79,7 @@ FFT <- function(im.real,im.imag,inverse=FALSE)
 ##' @param interpolation interpolation method to use (see doc for resize). Default 3, linear. Set to 5 for cubic, 6 for Lanczos (higher quality).
 ##' @return an image
 ##' @references
-##' For double-scale, triple-scale, etc. uses an anisotropic scaling algorithm described in: \url{http://scale2x.sourceforge.net/algorithm.html}. For half-scaling uses what the CImg doc describes as an "optimised filter", see resize_halfXY in CImg.h.
+##' For double-scale, triple-scale, etc. uses an anisotropic scaling algorithm described in: \url{http://www.scale2x.it/algorithm.html}. For half-scaling uses what the CImg doc describes as an "optimised filter", see resize_halfXY in CImg.h.
 ##' @seealso resize
 ##' @examples
 ##' im <- load.example("parrots")