R/calculaPerc.R

In Fgmutils: Forest Growth Model Utilities

## Copyright (C) 2016  Clayton Vieira Fraga Filho
##
## This program is free software; you can redistribute it and/or
## modify it under the terms of the GNU General Public License
## as published by the Free Software Foundation; either version 2
## of the License, or (at your option) any later version.
##  
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
## 
## You should have received a copy of the GNU General Public License
## along with this program; if not, write to the Free Software
## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

#' @title calculates percentage
#' @description With this function, you can calculate the ratio of one quantity or magnitude relative to another evaluated in percentage.
#' @param valor number amount you to know the percentage
#' @param observados number relationship to which you want to calculate the percentage, if it is a vector of integers is calculated its average.
#' @details calculaPerc = ((valor)/mean(observados))*100
#' @export
calculaPerc <- function(valor, observados)
{
  ((valor)/mean(observados))*100
}