From df375b5259c0fd8b748528a60ea96a3b302657db Mon Sep 17 00:00:00 2001
From: Jean Cochrane <jean.cochrane@cookcountyil.gov>
Date: Tue, 3 Dec 2024 17:43:44 +0000
Subject: [PATCH] Update roxygen docs to remove vars_check_class and tweak
 vars_recode docs

---
 man/vars_check_class.Rd | 42 -----------------------------------------
 man/vars_recode.Rd      |  3 +--
 man/vars_rename.Rd      |  1 -
 3 files changed, 1 insertion(+), 45 deletions(-)
 delete mode 100644 man/vars_check_class.Rd

diff --git a/man/vars_check_class.Rd b/man/vars_check_class.Rd
deleted file mode 100644
index 06932c1..0000000
--- a/man/vars_check_class.Rd
+++ /dev/null
@@ -1,42 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/vars_funs.R
-\name{vars_check_class}
-\alias{vars_check_class}
-\title{Check if a property class falls within its expected square footage and age
-boundaries}
-\usage{
-vars_check_class(age, sqft, class)
-}
-\arguments{
-\item{age}{Integer or numeric vector of ages of properties. Either 1 long
-or the same length as \code{sqft} and \code{class}.}
-
-\item{sqft}{Integer or numeric vector of the square footage of properties.
-Either 1 long or the same length as \code{age} and \code{class}.}
-
-\item{class}{String or character vector of class codes. Either 1 long or
-the same length as \code{sqft} and \code{age}.}
-}
-\value{
-A logical vector indicating that the specified class falls within
-  the parameters specified by \code{\link{class_dict}}. Throws error if input
-  data types are incorrect or if length conditions of input vectors
-  are not met.
-}
-\description{
-Check property characteristics against class definitions as defined # nolint
-\href{https://datascience.cookcountyassessor.com/wiki/data/class-definitions.pdf}{here}. # nolint
-}
-\examples{
-vars_check_class(50, 800, "202")
-vars_check_class(c(50, 80), c(800, 1000), c("202", "203"))
-vars_check_class(c(50, 80), 1000, "210")
-vars_check_class(50, c(800, 2000), "202")
-vars_check_class(50, 1000, c("202", "203"))
-}
-\seealso{
-Other vars_funs: 
-\code{\link{vars_recode}()},
-\code{\link{vars_rename}()}
-}
-\concept{vars_funs}
diff --git a/man/vars_recode.Rd b/man/vars_recode.Rd
index 1d4877f..c1139a5 100644
--- a/man/vars_recode.Rd
+++ b/man/vars_recode.Rd
@@ -37,7 +37,7 @@ columns.
 The system of record stores characteristic values in a
 numerically encoded format. This function can be used to translate those
 values into a human-readable format. For example, EXT_WALL = 2 will become
-EXT_WALL = "Frame + Masonry". Note that the values and their translations are
+EXT_WALL = "Masonry". Note that the values and their translations are
 must be specified via a user-defined dictionary. The default dictionary is
 \code{\link{vars_dict}}.
 
@@ -101,7 +101,6 @@ vars_recode(
 }
 \seealso{
 Other vars_funs: 
-\code{\link{vars_check_class}()},
 \code{\link{vars_rename}()}
 }
 \concept{vars_funs}
diff --git a/man/vars_rename.Rd b/man/vars_rename.Rd
index 4d51afd..c8dfa8a 100644
--- a/man/vars_rename.Rd
+++ b/man/vars_rename.Rd
@@ -89,7 +89,6 @@ vars_rename(
 }
 \seealso{
 Other vars_funs: 
-\code{\link{vars_check_class}()},
 \code{\link{vars_recode}()}
 }
 \concept{vars_funs}