`yaml_write()` fails when `active` argument is a function that returns FALSE
Open
@rich-iannone is already working on this.
Since Sep 17, 2021.
Difficulty: [2] Intermediate
Effort: [3] High
Priority: [3] High
Type: ☹︎ Bug
- Dominant language
- R
- Stars
- 1k
- Forks
- 59
- Avg merge
- 25m
- Merged PRs (30d)
- 4
Description
Prework
- Read and agree to the code of conduct and contributing guidelines.
- If there is already a relevant issue, whether open or closed, comment on the existing thread instead of posting a new issue.
- Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
- Runnable: post enough R code and data so any onlooker can create the error on their own computer.
- Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
- Readable: format your code according to the tidyverse style guide.
Description
The yaml_write() function does not appear to work when active is provided an anonymous function the returns FALSE.
I suspect #345 could be related since it covers another edge case where write_yaml() fails a receiving a function versus a value as input. However, I thought this seemed like a distinct enough problem to merit its own issue.
The broader context for this problem is:
- I want to have checks in my pipeline that may not have matches (e.g.
starts_with('N')when data may or may not have any such columns) - In
pointblank0.6.0, I was able to do this so long as I explicitly provided thestep_id - I find in
pointblank0.8.0 and beyond, I get errors unless I use theactiveargument (shown in first part of reprex) - Passing a function to
activemakes interrogation work but breakswrite_yaml()if the function returnsFALSE
Reproducible example
- Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
- Runnable: post enough R code and data so any onlooker can create the error on their own computer.
- Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
- Readable: format your code according to the tidyverse style guide.
library(pointblank)
# no `active` doesn't interrogate ----
agent1 <-
create_agent(read_fn = ~data.frame(IND_A = 1, AMT_B = 2)) %>%
col_vals_not_null(starts_with("ID"), step_id = 1) %>%
col_vals_not_null(starts_with("IND"), step_id = 2)
res1 <- interrogate(agent1)
#> Error: Only strings can be converted to symbols
# `active` (FALSE function) does interrogate; doesn't write yaml ----
agent2 <-
create_agent(read_fn = ~data.frame(IND_A = 1, AMT_B = 2)) %>%
col_vals_not_null(
starts_with("ID"), step_id = 1,
active = ~. %>% {length(starts_with("ID", vars = colnames(.))) > 0} ) %>%
col_vals_not_null(starts_with("IND"), step_id = 2)
res2 <- interrogate(agent2)
#> i Step 1 is not set as active. Skipping.
yaml_write(agent2, filename = "pb-test-2.yml", path = tempdir())
#> Error in if (step_list$column[[1]] == step_list$columns_expr) {: missing value where TRUE/FALSE needed
# `active` (TRUE function) does interrogate; writes yaml ----
agent3 <-
create_agent(read_fn = ~data.frame(IND_A = 1, AMT_B = 2)) %>%
col_vals_not_null(
starts_with("AMT"), step_id = 1,
active = ~. %>% {length(starts_with("AMT", vars = colnames(.))) > 0} ) %>%
col_vals_not_null(starts_with("IND"), step_id = 2)
res3 <- interrogate(agent3)
yaml_write(agent3, filename = "pb-test-3.yml", path = tempdir())
#> v The agent YAML file has been written to `C:\Users\emily\AppData\Local\Temp\RtmpKIp4r6/pb-test-3.yml`
readLines(file.path(tempdir(), "pb-test-3.yml"))
#> [1] "type: agent"
#> [2] "read_fn: ~data.frame(IND_A = 1, AMT_B = 2)"
#> [3] "tbl_name: ~"
#> [4] "label: '[2021-09-17|08:13:32]'"
#> [5] "lang: en"
#> [6] "locale: en"
#> [7] "steps:"
#> [8] "- col_vals_not_null:"
#> [9] " columns: starts_with(\"AMT\")"
#> [10] " active: |-"
#> [11] " ~. %>% {"
#> [12] " length(starts_with(\"AMT\", vars = colnames(.))) > 0"
#> [13] " }"
#> [14] "- col_vals_not_null:"
#> [15] " columns: starts_with(\"IND\")"
# `active` (value not function) with cols present does interrogate; writes yaml ----
agent4 <-
create_agent(read_fn = ~data.frame(IND_A = 1, AMT_B = 2)) %>%
col_vals_not_null(
starts_with("AMT"), step_id = 1, active = FALSE) %>%
col_vals_not_null(starts_with("IND"), step_id = 2)
res4 <- interrogate(agent4)
#> i Step 1 is not set as active. Skipping.
yaml_write(agent4, filename = "pb-test-4.yml", path = tempdir())
#> v The agent YAML file has been written to `C:\Users\emily\AppData\Local\Temp\RtmpKIp4r6/pb-test-4.yml`
readLines(file.path(tempdir(), "pb-test-4.yml"))
#> [1] "type: agent"
#> [2] "read_fn: ~data.frame(IND_A = 1, AMT_B = 2)"
#> [3] "tbl_name: ~"
#> [4] "label: '[2021-09-17|08:13:32]'"
#> [5] "lang: en"
#> [6] "locale: en"
#> [7] "steps:"
#> [8] "- col_vals_not_null:"
#> [9] " columns: starts_with(\"AMT\")"
#> [10] " active: false"
#> [11] "- col_vals_not_null:"
#> [12] " columns: starts_with(\"IND\")"
Created on 2021-09-17 by the reprex package (v0.3.0)
Session info
devtools::session_info()
#> Error in get(genname, envir = envir) : object 'testthat_print' not found
#> - Session info ---------------------------------------------------------------
#> setting value
#> version R version 4.0.2 (2020-06-22)
#> os Windows 10 x64
#> system x86_64, mingw32
#> ui RTerm
#> language (EN)
#> collate English_United States.1252
#> ctype English_United States.1252
#> tz America/Chicago
#> date 2021-09-17
#>
#> - Packages -------------------------------------------------------------------
#> package * version date lib
#> assertthat 0.2.1 2019-03-21 [1]
#> backports 1.1.7 2020-05-13 [1]
#> blastula 0.3.2 2020-05-19 [1]
#> callr 3.4.3 2020-03-28 [1]
#> cli 2.5.0 2021-04-26 [1]
#> crayon 1.3.4 2017-09-16 [1]
#> DBI 1.1.0 2019-12-15 [1]
#> desc 1.2.0 2018-05-01 [1]
#> devtools 2.3.1 2020-07-21 [1]
#> digest 0.6.27 2020-10-24 [1]
#> dplyr 1.0.7 2021-06-18 [1]
#> ellipsis 0.3.2 2021-04-29 [1]
#> evaluate 0.14 2019-05-28 [1]
#> fansi 0.4.1 2020-01-08 [1]
#> fs 1.5.0 2020-07-31 [1]
#> generics 0.1.0 2020-10-31 [1]
#> glue 1.4.2 2020-08-27 [1]
#> highr 0.8 2019-03-20 [1]
#> htmltools 0.5.1.1 2021-01-22 [1]
#> knitr 1.33.8 2021-08-08 [1]
#> lifecycle 1.0.0 2021-02-15 [1]
#> magrittr 2.0.1 2020-11-17 [1]
#> memoise 1.1.0 2017-04-21 [1]
#> pillar 1.6.2 2021-07-29 [1]
#> pkgbuild 1.1.0 2020-07-13 [1]
#> pkgconfig 2.0.3 2019-09-22 [1]
#> pkgload 1.1.0 2020-05-29 [1]
#> pointblank * 0.8.0.9000 2021-09-17 [1]
#> prettyunits 1.1.1 2020-01-24 [1]
#> processx 3.4.3 2020-07-05 [1]
#> ps 1.3.4 2020-08-11 [1]
#> purrr 0.3.4 2020-04-17 [1]
#> R6 2.5.0 2020-10-28 [1]
#> remotes 2.2.0 2020-07-21 [1]
#> rlang 0.4.11 2021-04-30 [1]
#> rmarkdown 2.8 2021-05-07 [1]
#> rprojroot 1.3-2 2018-01-03 [1]
#> rstudioapi 0.13 2020-11-12 [1]
#> sessioninfo 1.1.1 2018-11-05 [1]
#> stringi 1.4.6 2020-02-17 [1]
#> stringr 1.4.0 2019-02-10 [1]
#> testthat 2.3.2 2020-03-02 [1]
#> tibble 3.1.4 2021-08-25 [1]
#> tidyselect 1.1.1 2021-04-30 [1]
#> usethis 2.0.1 2021-02-10 [1]
#> utf8 1.1.4 2018-05-24 [1]
#> vctrs 0.3.8 2021-04-29 [1]
#> withr 2.4.2 2021-04-18 [1]
#> xfun 0.23 2021-05-15 [1]
#> yaml 2.2.1 2020-02-01 [1]
#> source
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.0)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.3)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.3)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.3)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> Github (yihui/knitr@55a2df9)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.3)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> Github (rich-iannone/pointblank@40212d4)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.3)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.0)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.5)
#> CRAN (R 4.0.2)
#>
#> [1] C:/Users/emily/Documents/R/win-library/4.0
#> [2] C:/Program Files/R/R-4.0.2/library
title: reprex_reprex.R
author: emily
date: ‘2021-09-17’
Expected result
I would expect agent2 to behave the same was as agent3 when passed to write_yaml()
Session info
End the reproducible example with a call to sessionInfo() in the same session (e.g. reprex(si = TRUE)) and include the output.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.