Tidyverse upkeep (#673)

Do some tidy upkeep. Closes #661, closes #672.

Author: gorcha

.github/CODE_OF_CONDUCT.md

@@ -1,25 +1,126 @@
-# Contributor Code of Conduct
+# Contributor Covenant Code of Conduct
 
-As contributors and maintainers of this project, we pledge to respect all people who 
-contribute through reporting issues, posting feature requests, updating documentation,
-submitting pull requests or patches, and other activities.
+## Our Pledge
 
-We are committed to making participation in this project a harassment-free experience for
-everyone, regardless of level of experience, gender, gender identity and expression,
-sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
 
-Examples of unacceptable behavior by participants include the use of sexual language or
-imagery, derogatory comments or personal attacks, trolling, public or private harassment,
-insults, or other unprofessional conduct.
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments,
-commits, code, wiki edits, issues, and other contributions that are not aligned to this 
-Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed 
-from the project team.
+## Our Standards
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by 
-opening an issue or contacting one or more of the project maintainers.
+Examples of behavior that contributes to a positive environment for our
+community include:
 
-This Code of Conduct is adapted from the Contributor Covenant 
-(https://www.contributor-covenant.org), version 1.0.0, available at 
-https://contributor-covenant.org/version/1/0/0/.
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [email protected]. 
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][https://github.com/mozilla/inclusion].
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
+
+[homepage]: https://www.contributor-covenant.org

DESCRIPTION

@@ -15,18 +15,19 @@ URL: https://haven.tidyverse.org, https://github.com/tidyverse/haven,
     https://github.com/WizardMac/ReadStat
 BugReports: https://github.com/tidyverse/haven/issues
 Depends: 
-    R (>= 3.2)
+    R (>= 3.4)
 Imports: 
+    cli (>= 3.0.0),
     forcats (>= 0.2.0),
     hms,
+    lifecycle,
     methods,
     readr (>= 0.1.0),
     rlang (>= 0.4.0),
     tibble,
     tidyselect,
     vctrs (>= 0.3.0)
 Suggests: 
-    cli,
     covr,
     crayon,
     fs,

NAMESPACE

@@ -101,8 +101,11 @@ export(zap_missing)
 export(zap_widths)
 import(rlang)
 import(vctrs)
+importFrom(cli,cli_abort)
+importFrom(cli,cli_warn)
 importFrom(forcats,as_factor)
 importFrom(hms,hms)
+importFrom(lifecycle,deprecated)
 importFrom(methods,setOldClass)
 importFrom(stats,median)
 importFrom(stats,quantile)

NEWS.md

@@ -2,6 +2,13 @@
 
 * Updated to ReadStat 1.1.8 RC (#650).
 
+* Errors and warnings now use `cli_abort()` and `cli_warning()`. cli >= 3.0.0
+  has been added to imports to support this change (#661).
+  
+* R 3.4 is now the minimum supported version, in line with [tidyverse  policy](https://www.tidyverse.org/blog/2019/04/r-version-support/).
+
+* haven now uses the lifecycle package to manage deprecations.
+
 * `labelled()` vectors now throw a warning when combining two vectors with
   conflicting labels (#667).
 

R/as_factor.R

@@ -60,7 +60,7 @@ as_factor.data.frame <- function(x, ..., only_labelled = TRUE) {
 #' @rdname as_factor
 #' @export
 as_factor.haven_labelled <- function(x, levels = c("default", "labels", "values", "both"),
-                               ordered = FALSE, ...) {
+                                     ordered = FALSE, ...) {
   levels <- match.arg(levels)
   label <- attr(x, "label", exact = TRUE)
   labels <- attr(x, "labels")

R/haven-package.R

@@ -5,7 +5,10 @@
 ## usethis namespace: start
 #' @import rlang
 #' @import vctrs
-#' @importFrom tibble tibble
+#' @importFrom cli cli_abort
+#' @importFrom cli cli_warn
 #' @importFrom hms hms
+#' @importFrom lifecycle deprecated
+#' @importFrom tibble tibble
 ## usethis namespace: end
 NULL

R/haven-sas.R

@@ -19,7 +19,8 @@
 #'   specified columns will be read from `data_file`.
 #' @param skip Number of lines to skip before reading data.
 #' @param n_max Maximum number of lines to read.
-#' @param cols_only **Deprecated**: Use `col_select` instead.
+#' @param cols_only `r lifecycle::badge("deprecated")` `cols_only` is no longer
+#'   supported; use `col_select` instead.
 #' @return A tibble, data frame variant with nice defaults.
 #'
 #'   Variable labels are stored in the "label" attribute of each variable. It is
@@ -32,11 +33,10 @@
 #' read_sas(path)
 read_sas <- function(data_file, catalog_file = NULL,
                      encoding = NULL, catalog_encoding = encoding,
-                     col_select = NULL, skip = 0L, n_max = Inf, cols_only = "DEPRECATED",
-                     .name_repair = "unique"
-  ) {
-  if (!missing(cols_only)) {
-    warning("`cols_only` is deprecated. Please use `col_select` instead.", call. = FALSE)
+                     col_select = NULL, skip = 0L, n_max = Inf, cols_only = deprecated(),
+                     .name_repair = "unique") {
+  if (lifecycle::is_present(cols_only)) {
+    lifecycle::deprecate_warn("2.2.0", "read_sas(cols_only)", "read_sas(col_select)")
     stopifnot(is.character(cols_only)) # used to only work with a char vector
 
     # guarantee a quosure to keep NULL and tidyselect logic clean downstream
@@ -62,7 +62,7 @@ read_sas <- function(data_file, catalog_file = NULL,
   switch(class(spec_data)[1],
     source_file = df_parse_sas_file(spec_data, spec_cat, encoding = encoding, catalog_encoding = catalog_encoding, cols_skip = cols_skip, n_max = n_max, rows_skip = skip, name_repair = .name_repair),
     source_raw = df_parse_sas_raw(spec_data, spec_cat, encoding = encoding, catalog_encoding = catalog_encoding, cols_skip = cols_skip, n_max = n_max, rows_skip = skip, name_repair = .name_repair),
-    stop("This kind of input is not handled", call. = FALSE)
+    cli_abort("This kind of input is not handled.")
   )
 }
 
@@ -96,16 +96,15 @@ write_sas <- function(data, path) {
 #' tmp <- tempfile(fileext = ".xpt")
 #' write_xpt(mtcars, tmp)
 #' read_xpt(tmp)
-read_xpt <- function(file, col_select = NULL, skip = 0, n_max = Inf, .name_repair = "unique"
-) {
+read_xpt <- function(file, col_select = NULL, skip = 0, n_max = Inf, .name_repair = "unique") {
   cols_skip <- skip_cols(read_xpt, {{ col_select }}, file)
   n_max <- validate_n_max(n_max)
 
   spec <- readr::datasource(file)
   switch(class(spec)[1],
     source_file = df_parse_xpt_file(spec, cols_skip, n_max, skip, name_repair = .name_repair),
     source_raw = df_parse_xpt_raw(spec, cols_skip, n_max, skip, name_repair = .name_repair),
-    stop("This kind of input is not handled", call. = FALSE)
+    cli_abort("This kind of input is not handled.")
   )
 }
 
@@ -121,12 +120,15 @@ read_xpt <- function(file, col_select = NULL, skip = 0, n_max = Inf, .name_repai
 #'   Note that although SAS itself supports dataset labels up to 256 characters
 #'   long, dataset labels in SAS transport files must be <= 40 characters.
 write_xpt <- function(data, path, version = 8, name = NULL, label = attr(data, "label")) {
-  stopifnot(version %in% c(5, 8))
+  if (!version %in% c(5, 8)) {
+    cli_abort("SAS transport file version {.val {version}} is not currently supported.")
+  }
 
   if (is.null(name)) {
     name <- tools::file_path_sans_ext(basename(path))
   }
   name <- validate_xpt_name(name, version)
+  label <- validate_xpt_label(label)
 
   data <- validate_sas(data)
   write_xpt_(
@@ -148,27 +150,26 @@ validate_sas <- function(data) {
   adjust_tz(data)
 }
 
-validate_xpt_name <- function(name, version) {
+validate_xpt_name <- function(name, version, call = caller_env()) {
   if (version == 5) {
     if (nchar(name) > 8) {
-      stop("`name` must be 8 characters or fewer", call. = FALSE)
+      cli_abort("{.arg name} must be 8 characters or fewer.", call = call)
     }
-
   } else {
     if (nchar(name) > 32) {
-      stop("`name` must be 32 characters or fewer", call. = FALSE)
+      cli_abort("{.arg name} must be 32 characters or fewer.", call = call)
     }
   }
   name
 }
 
-validate_xpt_label <- function(label) {
+validate_xpt_label <- function(label, call = caller_env()) {
   if (!is.null(label)) {
     stopifnot(is.character(label), length(label) == 1)
 
     if (nchar(label) > 40) {
-      stop("`label` must be 40 characters or fewer", call. = FALSE)
+      cli_abort("{.arg label} must be 40 characters or fewer.", call = call)
     }
   }
+  label
 }
-