% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/unsupervised-market-basket.R
\name{inspect_rules}
\alias{inspect_rules}
\title{Inspect Association Rules}
\usage{
inspect_rules(rules_obj, by = "lift", n = 10, decreasing = TRUE)
}
\arguments{
\item{rules_obj}{A tidy_apriori object or rules object}

\item{by}{Sort by: "support", "confidence", "lift" (default), "count"}

\item{n}{Number of rules to display (default: 10)}

\item{decreasing}{Sort in decreasing order? (default: TRUE)}
}
\value{
A tibble of the top \code{n} rules sorted by the specified quality
measure.
}
\description{
View rules sorted by various quality measures
}
\examples{
\donttest{
if (requireNamespace("arules", quietly = TRUE)) {
  data("Groceries", package = "arules")
  res <- tidy_apriori(Groceries, support = 0.001, confidence = 0.5)
  inspect_rules(res, by = "lift", n = 5)
}
}

}
