posit-dev / posit-dev/pointblank

Improve differentiation of multiple `col_vals_expr` steps in `get_tabular_report`

Open
#105 2 comments 1 reaction 1 assignee View on GitHub

@rich-iannone is already working on this.

Since Mar 20, 2025.

Difficulty: [2] Intermediate Effort: [2] Medium Priority: [3] High Type: ★ Enhancement
Dominant language
Python
Stars
490
Forks
32
Avg merge
14h 24m
Merged PRs (30d)
2

Description

Prework

Proposal

Great library! Thank you for all the work on it so far.

When including multiple custom column expressions (col_vals_expr) as steps, it becomes very difficult to tell them apart in get_tabular_report.

  • It would be helpful if the "columns" field was populated, i.e. via pl.Expr.meta.root_names(). This looks similar to what is available in the R version (rstudio/pointblank#570)
  • It would be helpful if the "step" column included the output name of the expression, if provided. i.e.
    (pl.col("a") % 1==0).alias("a_mod_1") would display as col_vals_expr(a_mod_1) instead of just col_vals_expr(). For polars, this can be done via pl.Expr.meta.output_name().
  • In addition, since every step has a "brief" input, it would be nice to have an option in Validate.get_tabular_report to add a column that displays these inputs across all steps. This would also help to relabel steps that use col_vals_regex once the regular expressions become too complicated to be intuitive to consumers of the report.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.