add rounding utilities

man/rnh.Rd

@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{rnh}
+\alias{rnh}
+\title{Round values to the nearest 0.5}
+\usage{
+rnh(x)
+}
+\arguments{
+\item{x}{a numeric vector to round}
+}
+\value{
+a numeric vector with all elements rounded to 0, 0.5, or 1
+}
+\description{
+Round values to the nearest 0.5
+}
+\examples{
+rnh(c(0.2, 0.3, 0.4, 0.8, 0.09, 0.9))
+}

man/round_to_nearest_half.Rd

@@ -0,0 +1,22 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{round_to_nearest_half}
+\alias{round_to_nearest_half}
+\title{Round values to the nearest 0.5}
+\usage{
+round_to_nearest_half(x)
+}
+\arguments{
+\item{x}{a numeric vector to round}
+}
+\value{
+a numeric vector with all elements rounded to 0, 0.5, or 1
+}
+\description{
+Round values to the nearest 0.5
+}
+\examples{
+round_to_nearest_half(0.9)
+round_to_nearest_half(0.7)
+round_to_nearest_half(0.4)
+}

man/trim_max.Rd

@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/utils.R
+\name{trim_max}
+\alias{trim_max}
+\title{Take the maximum of a number after trimming values}
+\usage{
+trim_max(vec, n)
+}
+\arguments{
+\item{vec}{a numeric vector}
+
+\item{n}{integer, the number of maximum values to trim before taking the maximum}
+}
+\value{
+the highest value after removing the highest n values
+}
+\description{
+Take the maximum of a number after trimming values
+}
+\examples{
+trim_max(c(10, 10, 10, 9, 8, 7), n = 2)
+trim_max(c(10, 10, 10, 9, 8, 7), n = 3)
+trim_max(c(10, 10, 10, 9, 8, 7), n = 4)
+}