Merge pull request #24 from UBC-DSCI/pointblank-py

pointblank python

Author: chendaniely

book/_quarto.yml

@@ -40,6 +40,7 @@ book:
       - lectures/131-data_validation-r-pointblank.qmd
       - lectures/135-data_validation-python-pandera.qmd
       - lectures/136-data_validation-python-deepchecks.qmd
+      - lectures/137-data_validation-python-pointblank.qmd
     - part: parts/automation.qmd
       chapters:
       - lectures/150-scripts.qmd

book/lectures/137-data_validation-python-pointblank.qmd

@@ -0,0 +1,61 @@
+---
+title: "Python Data Validation: pointblank"
+---
+
+This chapter goes through the `{pointblank}` R package that has been ported into Python:
+<https://posit-dev.github.io/pointblank/>
+
+
+```{python}
+import pointblank as pb
+
+small_table = pb.load_dataset(dataset="small_table")
+small_table
+```
+
+## Validation rules
+
+
+```{python}
+pb.Validate(small_table).col_vals_lt(columns="a", value=10)
+```
+
+
+```{python}
+pb.Validate(small_table).col_vals_lt(columns="a", value=5)
+```
+
+
+```{python}
+validation = (
+    pb.Validate(small_table)
+    .col_vals_between(columns="d", left=0, right=5000)
+    .col_vals_le(columns="c", value=5)
+    .col_exists(columns=["date", "date_time"])
+    .interrogate()
+)
+
+validation
+```
+
+## Post-interrogation
+
+
+```{python}
+validation = (
+    pb.Validate(small_table)
+    .col_vals_between(columns="d", left=0, right=5000)
+    .col_vals_le(columns="c", value=5)
+    .col_exists(columns=["date", "date_time"])
+    .interrogate()
+)
+```
+
+
+```{python}
+validation.get_sundered_data(type="pass")
+```
+
+```{python}
+validation.get_sundered_data(type="fail")
+```

requirements.txt

@@ -4,3 +4,5 @@ PyYAML
 pandas
 pandera==0.21.0
 pytest
+pointblank
+polars