Merge pull request #178 from atorus-research/release_0.3.1

Release 0.3.1

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: xportr
 Title: Utilities to Output CDISC SDTM/ADaM XPT Files
-Version: 0.3.0
+Version: 0.3.1
 Authors@R: 
  c(
  person(given = "Eli",

NAMESPACE

@@ -14,6 +14,7 @@ export(xportr_metadata)
 export(xportr_order)
 export(xportr_type)
 export(xportr_write)
+export(xpt_validate)
 import(haven)
 import(rlang)
 importFrom(cli,cli_alert_danger)

R/support-test.R

@@ -111,6 +111,7 @@ minimal_metadata <- function(dataset = FALSE,
 #' @param `[environment(1)]`\cr Attach exit handlers to this environment. Typically, this should
 #' be either the current environment or a parent frame
 #' (accessed through parent.frame()).
+#' @noRd
 #' @keywords internal
 local_cli_theme <- function(.local_envir = parent.frame()) {
  cli_theme_tests <- list(

R/utils-xportr.R

@@ -175,10 +175,14 @@ xpt_validate_var_names <- function(varnames,
 
 #' Validate Dataset Can be Written to xpt
 #'
+#' Function used to validate dataframes before they are sent to
+#' `haven::write_xpt` for writing.
+#'
 #' @param data Dataset to be exported as xpt file
 #'
-#' @return xpt file
-#' @noRd
+#' @return Returns a character vector of failed conditions
+#'
+#' @export
 xpt_validate <- function(data) {
  err_cnd <- character()
 

README.Rmd

@@ -21,9 +21,8 @@ library(fontawesome)
 <!-- badges: start -->
 [<img src="https://img.shields.io/badge/Slack-RValidationHub-blue?style=flat&logo=slack">](https://RValidationHub.slack.com)
 [![R build status](https://github.com/atorus-research/xportr/workflows/R-CMD-check/badge.svg)](https://github.com/atorus-research/xportr/actions?workflow=R-CMD-check)
-[<img src="https://img.shields.io/codecov/c/github/atorus-research/xportr">](https://app.codecov.io/gh/atorus-research/xportr)
+[<img src="https://img.shields.io/codecov/c/gh/atorus-research/xportr">](https://app.codecov.io/gh/atorus-research/xportr)
 [<img src="https://img.shields.io/badge/License-MIT-blue.svg">](https://github.com/atorus-research/xportr/blob/master/LICENSE)
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental-1)
 <!-- badges: end -->
 
 

README.md

@@ -8,10 +8,8 @@
 [<img src="https://img.shields.io/badge/Slack-RValidationHub-blue?style=flat&logo=slack">](https://RValidationHub.slack.com)
 [![R build
 status](https://github.com/atorus-research/xportr/workflows/R-CMD-check/badge.svg)](https://github.com/atorus-research/xportr/actions?workflow=R-CMD-check)
-[<img src="https://img.shields.io/codecov/c/github/atorus-research/xportr">](https://app.codecov.io/gh/atorus-research/xportr)
+[<img src="https://img.shields.io/codecov/c/gh/atorus-research/xportr">](https://app.codecov.io/gh/atorus-research/xportr)
 [<img src="https://img.shields.io/badge/License-MIT-blue.svg">](https://github.com/atorus-research/xportr/blob/master/LICENSE)
-[![Lifecycle:
-experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental-1)
 <!-- badges: end -->
 
 Welcome to `xportr`! We have designed `xportr` to help get your xpt
@@ -141,7 +139,7 @@ adsl %>%
  xportr_length(var_spec, "ADSL", verbose = "warn") %>%
  xportr_label(var_spec, "ADSL", verbose = "warn") %>%
  xportr_order(var_spec, "ADSL", verbose = "warn") %>%
- xportr_format(var_spec, "ADSL", verbose = "warn") %>%
+ xportr_format(var_spec, "ADSL") %>%
  xportr_write("adsl.xpt", label = "Subject-Level Analysis Dataset")
 ```