Updated the documentations

.Rproj.user/D9B41A7/pcs/windowlayoutstate.pper

@@ -7,7 +7,7 @@
     },
     "right" : {
         "panelheight" : 817,
-        "splitterpos" : 511,
+        "splitterpos" : 510,
         "topwindowstate" : "NORMAL",
         "windowheight" : 855
     }

.Rproj.user/D9B41A7/persistent-state

 build-last-errors="[]"
 build-last-errors-base-dir="~/Documents/These/Works/Current models/R_packages/rterahertz/"
-build-last-outputs="[{\"output\":\"==> devtools::document(roclets = c('rd', 'collate', 'namespace'))\\n\\n\",\"type\":0},{\"output\":\"Updating rterahertz documentation\\n\",\"type\":2},{\"output\":\"Loading rterahertz\\n\",\"type\":2},{\"output\":\"Warning: The existing 'NAMESPACE' file was not generated by roxygen2, and will not be overwritten.\\n\",\"type\":2},{\"output\":\"Documentation completed\\n\\n\",\"type\":1},{\"output\":\"==> R CMD INSTALL --preclean --no-multiarch --with-keep.source rterahertz\\n\\n\",\"type\":0},{\"output\":\"* installing to library ‘/Library/Frameworks/R.framework/Versions/3.6/Resources/library’\\n\",\"type\":1},{\"output\":\"* installing *source* package ‘rterahertz’ ...\\n\",\"type\":1},{\"output\":\"** using staged installation\\n\",\"type\":1},{\"output\":\"** R\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** byte-compile and prepare package for lazy loading\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** help\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"*** installing help indices\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** building package indices\\n\",\"type\":1},{\"output\":\"** testing if installed package can be loaded from temporary location\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** testing if installed package can be loaded from final location\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** testing if installed package keeps a record of temporary installation path\\n\",\"type\":1},{\"output\":\"* DONE (rterahertz)\\n\",\"type\":1},{\"output\":\"\",\"type\":1}]"
+build-last-outputs="[{\"output\":\"==> devtools::document(roclets = c('rd', 'collate', 'namespace'))\\n\\n\",\"type\":0},{\"output\":\"Updating rterahertz documentation\\n\",\"type\":2},{\"output\":\"Loading rterahertz\\n\",\"type\":2},{\"output\":\"Warning: The existing 'NAMESPACE' file was not generated by roxygen2, and will not be overwritten.\\n\",\"type\":2},{\"output\":\"Documentation completed\\n\\n\",\"type\":1},{\"output\":\"==> R CMD INSTALL --preclean --no-multiarch --with-keep.source rterahertz\\n\\n\",\"type\":0},{\"output\":\"* installing to library ‘/Library/Frameworks/R.framework/Versions/3.6/Resources/library’\\n\",\"type\":1},{\"output\":\"* installing *source* package ‘rterahertz’ ...\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** using staged installation\\n\",\"type\":1},{\"output\":\"** R\\n\",\"type\":1},{\"output\":\"** byte-compile and prepare package for lazy loading\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** help\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"*** installing help indices\\n\",\"type\":1},{\"output\":\"** building package indices\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** testing if installed package can be loaded from temporary location\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** testing if installed package can be loaded from final location\\n\",\"type\":1},{\"output\":\"\",\"type\":1},{\"output\":\"** testing if installed package keeps a record of temporary installation path\\n\",\"type\":1},{\"output\":\"* DONE (rterahertz)\\n\",\"type\":1},{\"output\":\"\",\"type\":1}]"
 compile_pdf_state="{\"errors\":[],\"output\":\"\",\"running\":false,\"tab_visible\":false,\"target_file\":\"\"}"
 files.monitored-path=""
 find-in-files-state="{\"handle\":\"\",\"input\":\"\",\"path\":\"\",\"regex\":true,\"results\":{\"file\":[],\"line\":[],\"lineValue\":[],\"matchOff\":[],\"matchOn\":[]},\"running\":false}"

R/operationareamat.R

@@ -9,6 +9,18 @@
 #'
 #' @param m A matrix object
 #'
+#' @param rowmin The first row for subsetting. Taking an example from the description above,
+#' the rowmin is 1
+#'
+#' @param rowmax The last row for subsetting. Taking an example from the description above,
+#' the rowmax is 3
+#'
+#' @param colmin The first column for subsetting. Taking an example from the description above,
+#' the colmin is 2
+#'
+#' @param colmax The last column for subsetting. Taking an example from the description above,
+#' the colmax is 5
+#'
 #' @return The mean value of the subsetted area of matrix m
 #'
 #' @examples
@@ -38,6 +50,18 @@ meanareamat <- function(m, rowmin, rowmax, colmin, colmax){
 #'
 #' @param m A matrix object
 #'
+#' @param rowmin The first row for subsetting. Taking an example from the description above,
+#' the rowmin is 1
+#'
+#' @param rowmax The last row for subsetting. Taking an example from the description above,
+#' the rowmax is 3
+#'
+#' @param colmin The first column for subsetting. Taking an example from the description above,
+#' the colmin is 2
+#'
+#' @param colmax The last column for subsetting. Taking an example from the description above,
+#' the colmax is 5
+#'
 #' @return The median value of the subsetted area of matrix m
 #'
 #' @examples
@@ -67,6 +91,18 @@ medianareamat <- function(m, rowmin, rowmax, colmin, colmax){
 #'
 #' @param m A matrix object
 #'
+#' @param rowmin The first row for subsetting. Taking an example from the description above,
+#' the rowmin is 1
+#'
+#' @param rowmax The last row for subsetting. Taking an example from the description above,
+#' the rowmax is 3
+#'
+#' @param colmin The first column for subsetting. Taking an example from the description above,
+#' the colmin is 2
+#'
+#' @param colmax The last column for subsetting. Taking an example from the description above,
+#' the colmax is 5
+#'
 #' @return The standard deviation value of the subsetted area of matrix m
 #'
 #' @examples

man/meanareamat.Rd

@@ -8,6 +8,18 @@ meanareamat(m, rowmin, rowmax, colmin, colmax)
 }
 \arguments{
 \item{m}{A matrix object}
+
+\item{rowmin}{The first row for subsetting. Taking an example from the description above,
+the rowmin is 1}
+
+\item{rowmax}{The last row for subsetting. Taking an example from the description above,
+the rowmax is 3}
+
+\item{colmin}{The first column for subsetting. Taking an example from the description above,
+the colmin is 2}
+
+\item{colmax}{The last column for subsetting. Taking an example from the description above,
+the colmax is 5}
 }
 \value{
 The mean value of the subsetted area of matrix m

man/medianareamat.Rd

@@ -8,6 +8,18 @@ medianareamat(m, rowmin, rowmax, colmin, colmax)
 }
 \arguments{
 \item{m}{A matrix object}
+
+\item{rowmin}{The first row for subsetting. Taking an example from the description above,
+the rowmin is 1}
+
+\item{rowmax}{The last row for subsetting. Taking an example from the description above,
+the rowmax is 3}
+
+\item{colmin}{The first column for subsetting. Taking an example from the description above,
+the colmin is 2}
+
+\item{colmax}{The last column for subsetting. Taking an example from the description above,
+the colmax is 5}
 }
 \value{
 The median value of the subsetted area of matrix m

man/sdareamat.Rd

@@ -8,6 +8,18 @@ sdareamat(m, rowmin, rowmax, colmin, colmax)
 }
 \arguments{
 \item{m}{A matrix object}
+
+\item{rowmin}{The first row for subsetting. Taking an example from the description above,
+the rowmin is 1}
+
+\item{rowmax}{The last row for subsetting. Taking an example from the description above,
+the rowmax is 3}
+
+\item{colmin}{The first column for subsetting. Taking an example from the description above,
+the colmin is 2}
+
+\item{colmax}{The last column for subsetting. Taking an example from the description above,
+the colmax is 5}
 }
 \value{
 The standard deviation value of the subsetted area of matrix m