add additional functions
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
Gitea Organization/civilyticsR/pipeline/head There was a failure building this commit
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/utils.R
|
||||
\name{safe_ratio}
|
||||
\alias{safe_ratio}
|
||||
\title{Safely take a ratio and do not fail if 0 is in the denominator}
|
||||
\usage{
|
||||
safe_ratio(num, denom)
|
||||
}
|
||||
\arguments{
|
||||
\item{num}{numerator, a numeric}
|
||||
|
||||
\item{denom}{denominator, a numeric}
|
||||
}
|
||||
\value{
|
||||
The proportion, safely calculated with 0.1 substituting for 0
|
||||
}
|
||||
\description{
|
||||
Safely take a ratio and do not fail if 0 is in the denominator
|
||||
}
|
||||
\examples{
|
||||
safe_ratio(100, 1)
|
||||
safe_ratio(100, 0)
|
||||
}
|
||||
Reference in New Issue
Block a user