stRoke/man/quantile_cut.Rd

51 lines
1.2 KiB
Plaintext
Raw Permalink Normal View History

2022-09-22 15:45:40 +02:00
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/quantile_cut.R
\name{quantile_cut}
\alias{quantile_cut}
\title{MOVED Easy function for splitting numeric variable in quantiles}
2022-09-22 15:45:40 +02:00
\usage{
quantile_cut(
x,
groups,
y = NULL,
na.rm = TRUE,
group.names = NULL,
ordered.f = FALSE,
inc.outs = FALSE,
2022-09-23 12:05:32 +02:00
detail.list = FALSE
2022-09-22 15:45:40 +02:00
)
}
\arguments{
\item{x}{Variable to cut.}
\item{groups}{Number of groups.}
2023-01-12 13:44:29 +01:00
\item{y}{alternative vector to draw quantile cuts from. Limits has
to be within x. Default is NULL.}
2022-09-22 15:45:40 +02:00
\item{na.rm}{Remove NA's. Default is TRUE.}
2023-01-12 13:44:29 +01:00
\item{group.names}{Names of groups to split to. Default is NULL,
giving intervals as names.}
2022-09-22 15:45:40 +02:00
\item{ordered.f}{Set resulting vector as ordered. Default is FALSE.}
2023-01-12 13:44:29 +01:00
\item{inc.outs}{Flag to include min(x) and max(x)
as borders in case of y!=NULL.}
2022-09-23 09:14:47 +02:00
2022-09-23 12:05:32 +02:00
\item{detail.list}{flag to include details or not}
}
\value{
vector or list with vector and details (length 2)
2022-09-22 15:45:40 +02:00
}
\description{
Using base/stats functions cut() and quantile().
}
\examples{
aa <- as.numeric(sample(1:1000,2000,replace = TRUE))
x <- 1:450
y <- 6:750
2022-09-23 09:14:47 +02:00
summary(quantile_cut(aa,groups=4,detail.list=FALSE)) ## Cuts quartiles
2022-09-22 15:45:40 +02:00
}
\keyword{quantile}