spelling fixes

DESCRIPTION

@@ -3,6 +3,7 @@ Type: Package
 Title: REgularization by Denoising (RED)
 Version: 1.0.0
 Author: person("Adriano", "Passos", email="adriano.utfpr@gmail.com", role=c("aut","cre"))
+Maintainer: Adriano G Passos, email: adriano.utfpr@gmail.com
 Description: Regularization by Denoising uses a denoising engine to solve many image reconstruction ill-posed inverse problems.
 Depends: R (>= 3.4.0), imager
 License: GPL-3

R/RED_pkg.R

@@ -1,10 +1,8 @@
-#' SRI: Super-resolution imaging package
-#'
-#' Super-resolution imaging (SR) is a class of techniques that enhance the resolution of an imaging system.
+#' RED: Regularization by Denoising
 #'
 #' @import imager
 #'
 #' @docType package
-#' @name SRI
+#' @name RED
 NULL
 

R/convolve.R

@@ -1,6 +1,6 @@
 #' Convolution of two images via FFT
 #'
-#' @param im,filter cimg objects
+#' @param im,filter \code{cimg} objects
 #' @param deconvolution logical indicating if the deconvolution should be performed
 #'
 #' @export

R/data.R

@@ -1,14 +1,14 @@
 #' Photograp of a cameraman
 #'
-#' This image is usualy used as benchmar in SR problems
+#' This image is usually used as benchmark in SR problems
 #'
 #' @format an image of class \code{cimg}
 'cameraman'
 
 # cameraman <- grayscale(cameraman)
 # devtools::use_data(cameraman)
 
-#' Photograp of Lenna
+#' Photograph of Lenna
 #'
 #' The Lenna (or Lena) picture is one of the most widely used standard test
 #' images used for compression algorithms

R/degrade.R

@@ -2,16 +2,16 @@
 #'
 #' This function degrades a high resolution image into a low resolution image.
 #'
-#' @param z a cimg object containing the high resolution image
+#' @param z a \code{cimg}object containing the high resolution image
 #' @inheritParams resample
 #' @inheritParams shift
 #' @param noise numeric indicating the standard deviation of the noise or an
-#'   cimg object that will be added to the resampled z
+#'   \code{cimg}object that will be added to the resampled z
 #' @param blur numeric indicating the blur range (for uniform blur) or an cimg
 #'   object with the blur kernel to be convolved with z if nothing is provided
 #'   an default kernel will be used.
 #'
-#' @return A degraded cimg object
+#' @return A degraded \code{cimg}object
 #'
 #' @export
 #' @examples

R/red.R

@@ -6,14 +6,14 @@
 #' @param step numeric indicating the step size (if NULL an optimal step size
 #'   will be used)
 #' @param lambda,sigma numeric indicating the regularization parameters
-#' @param tol numeric indicating the stoping criteria. The algorithm will stop
-#'   when step < tol. Default = 0.001
+#' @param tol numeric indicating the stopping criteria. The algorithm will stop
+#'   when \code{step < tol}. Default = 0.001
 #' @param functional character with the optimization task or function with the
 #'   functional to be used
 #' @param engine character indicating the denoised engine or function with the
 #'   denoiser engine to be used
-#' @param niter numeric indicating the maxistepm number of iterations
-#' @param args arguments to be passed implicity to H HT and f
+#' @param niter numeric indicating the maximum number of iterations
+#' @param args arguments to be passed implicitly to \code{H} \code{HT} and \code{f}
 #'
 #' @export
 #' @examples

R/resample.R

@@ -1,11 +1,11 @@
 #' Resampling of an image
 #'
-#' @param im cigm obect
-#' @param L numeric indicating the overal scale change. This param will be
-#'   overided by L1 or L2
+#' @param im \code{cimg} object
+#' @param L numeric indicating the overall scale change. This param will be
+#'   override by L1 or L2
 #' @param L1,L2 numeric indicating the directional scale change
 #'
-#' @return A resampled cimg object
+#' @return A resampled \code{cimg} object
 #'
 #' @export
 #' @examples

R/shift.R

@@ -2,7 +2,7 @@
 #'
 #' @param im cimg object
 #' @param s numeric \code{p} by \code{2} matrix containing the registration
-#'   sameters
+#'   parameters
 #'
 #' @return shifted cimg object
 #'

R/transform.R

@@ -1,10 +1,10 @@
 #' Transform an image
 #'
-#' @param im cimg object
+#' @param im \code{cimg} object
 #' @param s numeric \code{1} by \code{3} vector containing the registration
 #'   sameters
 #'
-#' @return shifted cimg object
+#' @return shifted \code{cimg} object
 #'
 #' @export
 #' @examples