Minor updates to doc

dahtah · Aug 26, 2015 · a84d687 · a84d687
1 parent 97872cb
commit a84d687
Show file tree

Hide file tree

Showing 90 changed files with 115 additions and 94 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.1.1): do not edit by hand
+# Generated by roxygen2 (4.1.1.9000): do not edit by hand
 
 S3method("[",cimg)
 S3method(as.array,cimg)

diff --git a/R/RcppExports.R b/R/RcppExports.R
@@ -755,9 +755,15 @@ im_split <- function(im, axis, nb = -1L) {
 #' All images will be concatenated along the x,y,z, or c axis.
 #' 
 #' @param imlist a list of images (all elements must be of class cimg) 
-#' @param axis the axis along which to split (for example 'c')
+#' @param axis the axis along which to concatenate (for example 'c')
 #' @seealso imsplit (the reverse operation)
 #' @export
+#' @examples
+#' imappend(list(boats,boats),"x") %>% plot
+#' imappend(list(boats,boats),"y") %>% plot
+#' plyr::rlply(3,imnoise(100,100)) %>% imappend("c") %>% plot
+#' boats.gs <- grayscale(boats)
+#' plyr::llply(seq(1,5,l=3),function(v) isoblur(boats.gs,v)) %>% imappend("c") %>% plot
 imappend <- function(imlist, axis) {
     .Call('imager_imappend', PACKAGE = 'imager', imlist, axis)
 }

diff --git a/R/cimg_class.R b/R/cimg_class.R
@@ -1,7 +1,8 @@
 #' imager: an R library for image processing, based on CImg
 #'
-#' CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds some basic plotting and subsetting. 
-#' You should install ImageMagick if you want support for common image formats (png, jpg, etc.)
+#' CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds many utilities for accessing and working with image data from R.
+#' You should install ImageMagick if you want support for image formats beyond PNG and JPEG, and ffmpeg if you need to work with videos (in which case you probably also want to take a look at experimental package imagerstreams on github).
+#' Package documentation is available at http://dahtah.github.io/imager/. 
 #' @docType package
 #' @name imager
 NULL

diff --git a/man/FFT.Rd b/man/FFT.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{FFT}
 \alias{FFT}

diff --git a/man/add.colour.Rd b/man/add.colour.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{add.colour}
 \alias{add.colour}

diff --git a/man/as.cimg.Rd b/man/as.cimg.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.cimg}
 \alias{as.cimg}

diff --git a/man/as.cimg.array.Rd b/man/as.cimg.array.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.cimg.array}
 \alias{as.cimg.array}

diff --git a/man/as.cimg.data.frame.Rd b/man/as.cimg.data.frame.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.cimg.data.frame}
 \alias{as.cimg.data.frame}

diff --git a/man/as.cimg.function.Rd b/man/as.cimg.function.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.cimg.function}
 \alias{as.cimg.function}

diff --git a/man/as.data.frame.cimg.Rd b/man/as.data.frame.cimg.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.data.frame.cimg}
 \alias{as.data.frame.cimg}

diff --git a/man/as.raster.cimg.Rd b/man/as.raster.cimg.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{as.raster.cimg}
 \alias{as.raster.cimg}

diff --git a/man/at.Rd b/man/at.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{at}
 \alias{at}

diff --git a/man/autocrop.Rd b/man/autocrop.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{autocrop}
 \alias{autocrop}

diff --git a/man/blur_anisotropic.Rd b/man/blur_anisotropic.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{blur_anisotropic}
 \alias{blur_anisotropic}

diff --git a/man/boats.Rd b/man/boats.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/datasets.R
 \docType{data}
 \name{boats}

diff --git a/man/boxblur.Rd b/man/boxblur.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{boxblur}
 \alias{boxblur}

diff --git a/man/boxblur_xy.Rd b/man/boxblur_xy.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{boxblur_xy}
 \alias{boxblur_xy}

diff --git a/man/bucketfill.Rd b/man/bucketfill.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/drawing.R
 \name{bucketfill}
 \alias{bucketfill}

diff --git a/man/capture.plot.Rd b/man/capture.plot.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{capture.plot}
 \alias{capture.plot}

diff --git a/man/center.stencil.Rd b/man/center.stencil.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{center.stencil}
 \alias{center.stencil}

diff --git a/man/channels.Rd b/man/channels.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{channels}
 \alias{channels}

diff --git a/man/cimg.Rd b/man/cimg.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{cimg}
 \alias{cimg}

diff --git a/man/cimg.dimensions.Rd b/man/cimg.dimensions.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{cimg.dimensions}
 \alias{cimg.dimensions}

diff --git a/man/cimg.extract.Rd b/man/cimg.extract.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{cimg.extract}
 \alias{B}

diff --git a/man/cimg2im.Rd b/man/cimg2im.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{cimg2im}
 \alias{cimg2im}

diff --git a/man/convolve.Rd b/man/convolve.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{convolve}
 \alias{convolve}

diff --git a/man/correlate.Rd b/man/correlate.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{correlate}
 \alias{correlate}

diff --git a/man/deriche.Rd b/man/deriche.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{deriche}
 \alias{deriche}

diff --git a/man/diffusion_tensors.Rd b/man/diffusion_tensors.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{diffusion_tensors}
 \alias{diffusion_tensors}

diff --git a/man/displacement.Rd b/man/displacement.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{displacement}
 \alias{displacement}

diff --git a/man/display.Rd b/man/display.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{display}
 \alias{display}

diff --git a/man/display_list.Rd b/man/display_list.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{display_list}
 \alias{display_list}

diff --git a/man/distance_transform.Rd b/man/distance_transform.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{distance_transform}
 \alias{distance_transform}

diff --git a/man/erode.Rd b/man/erode.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{erode}
 \alias{dilate}

diff --git a/man/extract_patches.Rd b/man/extract_patches.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{extract_patches}
 \alias{extract_patches}

diff --git a/man/frames.Rd b/man/frames.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{frames}
 \alias{frames}

diff --git a/man/get.locations.Rd b/man/get.locations.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{get.locations}
 \alias{get.locations}

diff --git a/man/get.stencil.Rd b/man/get.stencil.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{get.stencil}
 \alias{get.stencil}

diff --git a/man/get_gradient.Rd b/man/get_gradient.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{get_gradient}
 \alias{get_gradient}

diff --git a/man/get_hessian.Rd b/man/get_hessian.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{get_hessian}
 \alias{get_hessian}

diff --git a/man/grayscale.Rd b/man/grayscale.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{grayscale}
 \alias{grayscale}

diff --git a/man/haar.Rd b/man/haar.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{haar}
 \alias{haar}

diff --git a/man/idply.Rd b/man/idply.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{idply}
 \alias{idply}

diff --git a/man/iiply.Rd b/man/iiply.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{iiply}
 \alias{iiply}

diff --git a/man/ilply.Rd b/man/ilply.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{ilply}
 \alias{ilply}

diff --git a/man/im_split.Rd b/man/im_split.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{im_split}
 \alias{im_split}

diff --git a/man/imager.Rd b/man/imager.Rd
@@ -1,12 +1,13 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \docType{package}
 \name{imager}
 \alias{imager}
 \alias{imager-package}
 \title{imager: an R library for image processing, based on CImg}
 \description{
-CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds some basic plotting and subsetting.
-You should install ImageMagick if you want support for common image formats (png, jpg, etc.)
+CImg by David Tschumperle is a C++ library for image processing. It provides most common functions for image manipulation and filtering, as well as some advanced algorithms. imager makes these functions accessible from R and adds many utilities for accessing and working with image data from R.
+You should install ImageMagick if you want support for image formats beyond PNG and JPEG, and ffmpeg if you need to work with videos (in which case you probably also want to take a look at experimental package imagerstreams on github).
+Package documentation is available at http://dahtah.github.io/imager/.
 }
 
diff --git a/man/imager.colourspaces.Rd b/man/imager.colourspaces.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R, R/cimg_class.R
 \name{RGBtoHSL}
 \alias{HSItoRGB}

diff --git a/man/imager.combine.Rd b/man/imager.combine.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imager.combine}
 \alias{add}

diff --git a/man/imappend.Rd b/man/imappend.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{imappend}
 \alias{imappend}
@@ -9,11 +9,18 @@ imappend(imlist, axis)
 \arguments{
 \item{imlist}{a list of images (all elements must be of class cimg)}
 
-\item{axis}{the axis along which to split (for example 'c')}
+\item{axis}{the axis along which to concatenate (for example 'c')}
 }
 \description{
 All images will be concatenated along the x,y,z, or c axis.
 }
+\examples{
+imappend(list(boats,boats),"x") \%>\% plot
+imappend(list(boats,boats),"y") \%>\% plot
+plyr::rlply(3,imnoise(100,100)) \%>\% imappend("c") \%>\% plot
+boats.gs <- grayscale(boats)
+plyr::llply(seq(1,5,l=3),function(v) isoblur(boats.gs,v)) \%>\% imappend("c") \%>\% plot
+}
 \seealso{
 imsplit (the reverse operation)
 }

diff --git a/man/imdirac.Rd b/man/imdirac.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imdirac}
 \alias{imdirac}

diff --git a/man/imdraw.Rd b/man/imdraw.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imdraw}
 \alias{imdraw}

diff --git a/man/imfill.Rd b/man/imfill.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imfill}
 \alias{imfill}

diff --git a/man/imgradient.Rd b/man/imgradient.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imgradient}
 \alias{imgradient}

diff --git a/man/imhessian.Rd b/man/imhessian.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imhessian}
 \alias{imhessian}

diff --git a/man/imnoise.Rd b/man/imnoise.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/cimg_class.R
 \name{imnoise}
 \alias{imnoise}

diff --git a/man/imrotate.Rd b/man/imrotate.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{imrotate}
 \alias{imrotate}

diff --git a/man/imsharpen.Rd b/man/imsharpen.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.1.9000): do not edit by hand
 % Please edit documentation in R/RcppExports.R
 \name{imsharpen}
 \alias{imsharpen}