Skip to content

Commit f8968d6

Browse files
authored
Merge pull request #618 from yjunechoe/readme-edits
Some readme edits
2 parents cdad777 + 056cdef commit f8968d6

File tree

1 file changed

+26
-16
lines changed

1 file changed

+26
-16
lines changed

README.md

Lines changed: 26 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
[![Monthly Downloads](https://cranlogs.r-pkg.org/badges/pointblank)](https://CRAN.R-project.org/package=pointblank)
1515
[![Total Downloads](https://cranlogs.r-pkg.org/badges/grand-total/pointblank)](https://CRAN.R-project.org/package=pointblank)
1616
[![Posit Cloud](https://img.shields.io/badge/Posit%20Cloud-pointblank%20Test%20Drive-blue?style=social&logo=rstudio&logoColor=75AADB)](https://rstudio.cloud/project/3411822)
17+
[![Discord](https://img.shields.io/discord/1345877328982446110?color=%237289da&label=Discord)](https://discord.com/invite/YH7CybCNCQ)
1718
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html)
1819
<!-- badges: end -->
1920

@@ -78,14 +79,16 @@ agent <-
7879
actions = al
7980
) %>%
8081
col_vals_between(
81-
vars(a), 1, 9,
82+
columns = a,
83+
left = 1,
84+
right = 9,
8285
na_pass = TRUE
8386
) %>%
8487
col_vals_lt(
85-
vars(c), 12,
88+
columns = c, 12,
8689
preconditions = ~ . %>% dplyr::mutate(c = a + b)
8790
) %>%
88-
col_is_numeric(vars(a, b)) %>%
91+
col_is_numeric(columns = c(a, b)) %>%
8992
interrogate()
9093
```
9194

@@ -139,14 +142,17 @@ dplyr::tibble(
139142
b = c(6, 1, 0, 6, 0, 7)
140143
) %>%
141144
col_vals_between(
142-
a, 1, 9,
145+
columns = a,
146+
left = 1,
147+
right = 9,
143148
na_pass = TRUE
144149
) %>%
145150
col_vals_lt(
146-
c, 12,
151+
columns = c,
152+
value = 12,
147153
preconditions = ~ . %>% dplyr::mutate(c = a + b)
148154
) %>%
149-
col_is_numeric(c(a, b))
155+
col_is_numeric(columns = c(a, b))
150156
```
151157

152158
Error: Exceedance of failed test units where values in `c` should have been < `12`.
@@ -167,17 +173,20 @@ dplyr::tibble(
167173
b = c(6, 1, 0, 6, 0, 7)
168174
) %>%
169175
col_vals_between(
170-
a, 1, 9,
176+
columns = a,
177+
left = 1,
178+
right = 9,
171179
na_pass = TRUE,
172180
actions = warn_on_fail()
173181
) %>%
174182
col_vals_lt(
175-
c, 12,
183+
columns = c,
184+
value = 12,
176185
preconditions = ~ . %>% dplyr::mutate(c = a + b),
177186
actions = warn_on_fail()
178187
) %>%
179188
col_is_numeric(
180-
c(a, b),
189+
columns = c(a, b),
181190
actions = warn_on_fail()
182191
)
183192
```
@@ -340,13 +349,6 @@ a *Test Drive* in the [Posit Cloud project](https://rstudio.cloud/project/341182
340349

341350
<hr>
342351

343-
## DISCUSSIONS
344-
345-
Let's talk about data validation and data documentation in
346-
[**pointblank** Discussions](https://github.com/rstudio/pointblank/discussions)!
347-
It's a great place to ask questions about how to use the package, discuss
348-
some ideas, engage with others, and much more!
349-
350352
## INSTALLATION
351353

352354
Want to try this out? The **pointblank** package is available on **CRAN**:
@@ -362,10 +364,18 @@ You can also install the development version of **pointblank** from **GitHub**:
362364
pak::pak("rstudio/pointblank")
363365
```
364366

367+
## Getting in Touch
368+
365369
If you encounter a bug, have usage questions, or want to share ideas to
366370
make this package better, feel free to file an
367371
[issue](https://github.com/rstudio/pointblank/issues).
368372

373+
Wanna talk about data validation in a more relaxed setting? Join our
374+
[_Discord server_](https://discord.com/invite/YH7CybCNCQ)! This is a great option for asking about
375+
the development of Pointblank, pitching ideas that may become features, and just sharing your ideas!
376+
377+
[![Discord Server](https://img.shields.io/badge/Discord-Chat%20with%20us-blue?style=social&logo=discord&logoColor=purple)](https://discord.com/invite/YH7CybCNCQ)
378+
369379
-----
370380

371381
## Code of Conduct

0 commit comments

Comments
 (0)