Merge pull request #3 from gbganalyst/englue

Added str_englue()

.Rbuildignore

@@ -6,3 +6,4 @@
 ^cran-comments.md$
 ^\.github$
 ^CRAN-SUBMISSION$
+Rplot.png

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: forstringr
 Title: String Manipulation Package for Those Familiar with 'Microsoft Excel'
-Version: 0.0.1
+Version: 0.1.1
 Authors@R: c(
     person("Ezekiel", "Ogundepo", , email = "gbganalyst@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-3974-2733")),
@@ -25,6 +25,9 @@ Suggests:
 VignetteBuilder: knitr
 Imports: 
     dplyr,
+    ggplot2,
+    glue,
+    rlang,
     stringr,
     tidyselect
 Config/testthat/edition: 3

NAMESPACE

@@ -1,13 +1,20 @@
 # Generated by roxygen2: do not edit by hand
 
 export(length_omit_na)
+export(str_englue)
 export(str_extract_part)
 export(str_left)
 export(str_mid)
 export(str_right)
 export(str_rm_whitespace_df)
 export(str_split_extract)
+import(rlang)
 importFrom(dplyr,"%>%")
 importFrom(dplyr,across)
 importFrom(dplyr,mutate)
+importFrom(ggplot2,aes)
+importFrom(ggplot2,geom_histogram)
+importFrom(ggplot2,ggplot)
+importFrom(ggplot2,labs)
+importFrom(glue,glue)
 importFrom(stats,na.omit)

NEWS.md

@@ -1,9 +1,15 @@
 # What is New in *forstringr*
 
+## 0.1.1 (2023-04-10) 
+
+- Added `str_englue()`, an alias of `rlang::englue()`.
+
+- Added meaningful error messages for all the functions in the forstringr package.
+
 ## 0.0.1 (2022-08-29) 
 
 Added package logo, `community_data` (data containing whitespaces), `length_omit_na()`, and `str_extract_part()` functions, and modified unit tests.
 
 ## 0.0.0.9 (2022-07-20)
 
-The development version of forstringr is now on Githhub.
+The development version of forstringr is now on Githhub.

R/length_omit_na.R

@@ -18,5 +18,9 @@
 #' length(ethnicity)
 #'
 length_omit_na <- function(x) {
-  length(na.omit(x))
+  if (missing(x)) {
+    stop("argument 'x' is missing, with no default")
+  } else {
+    length(na.omit(x))
+  }
 }

R/str_englue.R

@@ -0,0 +1,29 @@
+#' Dynamic plot labels using glue operators
+#' @description
+#' `str_englue()` helps you solve the labeling problem during plotting. For example, any value wrapped in `{ }` will be inserted into the string and it can also understands embracing, `{{ }}`, which automatically inserts a given variable name.
+# Suppress R CMD check note for glue package (not use but   imported for rland)
+#' @importFrom glue glue
+#' @inheritParams rlang::englue
+#' @importFrom ggplot2 ggplot
+#' @importFrom ggplot2 aes
+#' @importFrom ggplot2 geom_histogram
+#' @importFrom ggplot2 labs
+#' @import rlang
+#'
+#' @seealso
+#' [rlang::englue()]
+#'
+#' @export
+#'
+#' @examples
+#' histogram_plot <- function(df, var, binwidth) {
+#'  df |>
+#'    ggplot(aes(x = {{ var }})) +
+#'    geom_histogram(binwidth = binwidth) +
+#'    labs(title = str_englue("A histogram of {{var}} with binwidth {binwidth}"))
+#'}
+
+#' iris |> histogram_plot(Sepal.Length, binwidth = 0.1)
+
+str_englue <- function(x, env, error_call, error_arg) englue(x, env = caller_env(), error_call = current_env(), error_arg = "x")
+

R/str_extract_part.R

@@ -10,7 +10,7 @@
 #' @return A subset of the input vector.
 #' @seealso
 #'
-#' [str_split_extract()] which splits up a string into pieces and extract the results using a specific index position.
+#' [str_split_extract()] which splits up a string into pieces and extracts the results using a specified index position.
 #'
 #' @export
 #'
@@ -25,11 +25,15 @@
 #'
 #' str_extract_part(c("$159", "$587", "$897"), before = FALSE, pattern = "$")
 #'
-str_extract_part <- function(string, before = TRUE, pattern) {
+str_extract_part <- function(string, pattern, before = TRUE) {
   before <- before
 
+  if (missing(string)) {
+    stop("argument 'string' is missing, with no default")
+  }
+
   if (missing(pattern)) {
-    stop("argument `pattern` is missing ")
+    stop("argument 'pattern' is missing, with no default")
   }
 
   esc_punt <- c("?", "$", "(", ")", "+", ".", "^", "*", "|", "[", "]", "_", "\\", "/", "s")

R/str_left.R

@@ -19,5 +19,9 @@
 #' str_left(c("Female", "Male", "Male", "Female"))
 #'
 str_left <- function(string, n = 1) {
-  substr(string, 1, n)
+  if (missing(string)) {
+    stop("argument 'string' is missing, with no default")
+  } else {
+    substr(string, 1, n)
+  }
 }

R/str_mid.R

@@ -17,5 +17,17 @@
 #' str_mid("Oyo Ibadan", 5, 6)
 #'
 str_mid <- function(string, start, n) {
-  substr(x = string, start = start, stop = start + n - 1)
+  if (missing(string)) {
+    stop("argument 'string' is missing, with no default")
+  }
+  if (missing(start)) {
+    stop("argument 'start' is missing, with no default! Please provide the string location to start extracting from")
+  }
+  if (missing(n)) {
+    stop("argument 'n' is missing, with no default! Please provide the string location to extract to")
+  } else {
+    substr(x = string, start = start, stop = start + n - 1)
+  }
 }
+
+

R/str_right.R

@@ -17,5 +17,9 @@
 #' str_right("Sale Price", n = 5)
 #'
 str_right <- function(string, n = 1) {
-  substr(string, nchar(string) - (n - 1), nchar(string))
+  if (missing(string)) {
+    stop("argument 'string' is missing, with no default")
+  } else {
+    substr(string, nchar(string) - (n - 1), nchar(string))
+  }
 }

R/str_rm_whitespace.R

@@ -15,5 +15,13 @@
 #' str_rm_whitespace_df(richest_in_nigeria)
 #'
 str_rm_whitespace_df <- function(df) {
-  df %>% mutate(across(tidyselect::vars_select_helpers$where(is.character), stringr::str_squish))
+  if (missing(df)) {
+    stop("argument 'df' is missing, with no default")
+  }
+
+  if (!is.data.frame(df)) {
+    stop("'df' must be a data frame object")
+  } else {
+    df %>% mutate(across(tidyselect::vars_select_helpers$where(is.character), stringr::str_squish))
+  }
 }

R/str_split_extract.R

@@ -15,6 +15,13 @@
 #' str_split_extract(code, "-", 4)
 #'
 str_split_extract <- function(string, pattern, position) {
+  if (missing(string)) {
+    stop("argument 'string' is missing, with no default")
+  }
+  if (missing(pattern)) {
+    stop("argument 'pattern' is missing, with no default")
+  }
+
   if (missing(position)) {
     stop("Please specify the index of vector you want to extract.")
   } else {

README.Rmd

@@ -112,15 +112,35 @@ first_name
 Extract strings before or after a given pattern. For example:
 
 ```{r example5b}
-first_name <- str_extract_part(top_10_richest_nig, before = TRUE, pattern = " ")
+first_name <- str_extract_part(top_10_richest_nig,  pattern = " ", before = TRUE)
 
 first_name
 
 revenue <- c("$159", "$587", "$891", "$207", "$793")
 
-str_extract_part(revenue, before = FALSE, pattern = "$")
+str_extract_part(revenue, pattern = "$", before = FALSE)
 ```
 
+## `str_englue()`
+
+You can dynamically label ggplot2 plots with the glue operators `[` or `{{}}` using `str_englue()`. For example, any value wrapped in `{ }` will be inserted into the string and you automatically inserts a given variable name using `{{ }}`.
+
+It is important to note that `str_englue()` must be used inside a function. `str_englue("{{ var }}")` defuses the argument `var` and transforms it to a string using the default name operation.
+
+```{r example_6, warning=FALSE, fig.width= 5.6, fig.height= 5}
+library(ggplot2)
+
+histogram_plot <- function(df, var, binwidth) {
+ df |>
+   ggplot(aes(x = {{ var }})) +
+   geom_histogram(binwidth = binwidth) +
+   labs(title = str_englue("A histogram of {{var}} with binwidth {binwidth}"))
+}
+
+iris |> histogram_plot(Sepal.Length, binwidth = 0.1)
+```
+
+
 ## `str_rm_whitespace_df()`
 
 Extra spaces are accidentally entered when working with survey data, and problems can arise when evaluating such data because of extra spaces. Therefore, the function `str_rm_whitespace_df()` eliminates your data frame unnecessary leading, trailing, or other whitespaces.

README.md

@@ -127,18 +127,44 @@ first_name
 Extract strings before or after a given pattern. For example:
 
 ``` r
-first_name <- str_extract_part(top_10_richest_nig, before = TRUE, pattern = " ")
+first_name <- str_extract_part(top_10_richest_nig,  pattern = " ", before = TRUE)
 
 first_name
 #>  [1] "Aliko"      "Mike"       "Femi"       "Arthur"     "Abdulsamad"
 #>  [6] "Cletus"     "Orji Uzor"  "ABC"        "Jimoh"      "Tony"
 
 revenue <- c("$159", "$587", "$891", "$207", "$793")
 
-str_extract_part(revenue, before = FALSE, pattern = "$")
+str_extract_part(revenue, pattern = "$", before = FALSE)
 #> [1] "159" "587" "891" "207" "793"
 ```
 
+## `str_englue()`
+
+You can dynamically label ggplot2 plots with the glue operators `[` or
+`{{}}` using `str_englue()`. For example, any value wrapped in `{ }`
+will be inserted into the string and you automatically inserts a given
+variable name using `{{ }}`.
+
+It is important to note that `str_englue()` must be used inside a
+function. `str_englue("{{ var }}")` defuses the argument `var` and
+transforms it to a string using the default name operation.
+
+``` r
+library(ggplot2)
+
+histogram_plot <- function(df, var, binwidth) {
+ df |>
+   ggplot(aes(x = {{ var }})) +
+   geom_histogram(binwidth = binwidth) +
+   labs(title = str_englue("A histogram of {{var}} with binwidth {binwidth}"))
+}
+
+iris |> histogram_plot(Sepal.Length, binwidth = 0.1)
+```
+
+<img src="man/figures/README-example_6-1.png" width="100%" />
+
 ## `str_rm_whitespace_df()`
 
 Extra spaces are accidentally entered when working with survey data, and

cran-comments.md

@@ -1,10 +1,10 @@
-## Resubmission
-This is a resubmission. In this version I have:
+## New version
 
-* Converted the DESCRIPTION title to title case.
+This is a new version submission. In this version I have:
 
-* Single quoted software names in the Title and Description fields of the DESCRIPTIOn file.
+- Added `str_englue()`, an alias of `rlang::englue()`.
 
+- Added meaningful error messages for all the functions in the forstringr package 
 
 ## R CMD check results
 0 errors | 0 warnings | 0 notes

tests/testthat/test-str_extract_part.R

@@ -1,13 +1,13 @@
 test_that("str_extract_part() returns only strings before the % sign", {
   expect_equal(
-    str_extract_part(c("5%", "92%", "75%"), TRUE, "%"),
+    str_extract_part(string = c("5%", "92%", "75%"), pattern =  "%", before = TRUE),
     c("5", "92", "75")
   )
 })
 
 test_that("str_extract_part() return only strings after -", {
   expect_equal(
-    str_extract_part(c("Good-Morning", "Good-Afternoon"), FALSE, "-"),
+    str_extract_part(string = c("Good-Morning", "Good-Afternoon"), pattern =  "-", before = FALSE),
     c("Morning", "Afternoon")
   )
 })

tests/testthat/test-test-str_englue.R

@@ -0,0 +1,7 @@
+g <- function(var) str_englue("{{ var }}")
+
+
+test_that("str_englue() automatically inserts a given variable name using a glue operator {{}}", {
+  expect_equal(g(cyl), "cyl")
+})
+