meanareamat.Rd 1.04 KB
Newer Older
1 2 3 4 5 6
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/operationareamat.R
\name{meanareamat}
\alias{meanareamat}
\title{Function for getting the mean value of an area on a matrix.}
\usage{
7
meanareamat(m, rowmin=1, rowmax, colmin=1, colmax)
8 9 10
}
\arguments{
\item{m}{A matrix object}
Ahmad Alkadri's avatar
Ahmad Alkadri committed
11

12
\item{rowmin}{The first row for subsetting. Default value is 1.}
Ahmad Alkadri's avatar
Ahmad Alkadri committed
13

14
\item{rowmax}{The last row for subsetting.}
Ahmad Alkadri's avatar
Ahmad Alkadri committed
15

16
\item{colmin}{The first column for subsetting. Default value is 1.}
Ahmad Alkadri's avatar
Ahmad Alkadri committed
17

18
\item{colmax}{The last column for subsetting.}
19 20 21 22 23 24 25 26 27 28 29 30 31 32
}
\value{
The mean value of the subsetted area of matrix m
}
\description{
A function for calculating the mean value of an area of a matrix.
For example if we want to get the mean value of part of a 10x10 matrix, starting from
2nd column, 1st row to 3rd row, 5th column, we'll get the values of this smaller matrix
(3x4 to be precise) and then we'll calculate the mean of all of them.
}
\examples{
m <- matrix(rnorm(100, mean = 0, sd = 1), nrow = 10, ncol = 10)
meanarea <- meanareamat(m, rowmin = 1, rowmax = 3, colmin = 2, colmax = 5)
}