Add `metrics` parameter to `data_tabulate()` by elinw · Pull Request #689 · easystats/datawizard

elinw · 2026-06-12T02:38:23Z

There were a few ways to approach this. The cumulative values depends on having the valid values, and it could make sense to just set any not included measures to NULL at the end, the way I did for valid.

I added a test for measures = "raw" ... I could add for other variations also.

Fixes #685

elinw · 2026-06-12T02:39:36Z

#685

etiennebacher

On top of the other comments to address above, please add a bullet point in NEWS.md and add an example for the new argument in the docs of data_tabulate().

(@strengejacke I hid all the copilot comments because they were just duplicates of your comments and adding noise to this PR)

elinw · 2026-06-12T17:42:12Z

I was wondering if it should be documented that measures = c() will return the frequencies only.
Also, that made me wonder if "N" should also be optional.

codecov · 2026-06-14T12:14:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.11%. Comparing base (89daeba) to head (258bd93).
⚠️ Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #689      +/-   ##
==========================================
+ Coverage   92.09%   92.11%   +0.02%     
==========================================
  Files          76       76              
  Lines        7727     7766      +39     
==========================================
+ Hits         7116     7154      +38     
- Misses        611      612       +1

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

etiennebacher

I was wondering if it should be documented that measures = c() will return the frequencies only.

Yes I think so.

Also, that made me wonder if "N" should also be optional.

I don't know about that but if it's not included then I think this measures parameter should be renamed shares. @strengejacke WDYT?

The workflow for code styling fails. We use Air to automatically format code so you can install it and run it on the project to fix this failure.

etiennebacher · 2026-06-14T12:09:48Z

+#' `NULL`. Can be `"raw"` (includes `NA` values), `"valid"` (excludes `NA` values)
+#' or `"cumulative"` (excludes `NA` values).


Suggested change

#' `NULL`. Can be `"raw"` (includes `NA` values), `"valid"` (excludes `NA` values)

#' or `"cumulative"` (excludes `NA` values).

#' `NULL`. Can be several choices among `"raw"` (includes `NA` values),

#' `"valid"` (excludes `NA` values) and `"cumulative"` (excludes `NA` values).

I changed the wording but not exactly to yours. See what you think.

etiennebacher · 2026-06-14T12:12:18Z

+* `data_tabulate()` gain a `measures` argument to allow selection of columns to
+  display ("raw", "valid", and "cumulative") (#689).


You can add your github username if you want: (#689, <username>)

elinw · 2026-06-15T20:30:27Z

I was wondering if it should be documented that measures = c() will return the frequencies only.

Yes I think so.

Also, that made me wonder if "N" should also be optional.

I don't know about that but if it's not included then I think this measures parameter should be renamed shares. @strengejacke WDYT?

The workflow for code styling fails. We use Air to automatically format code so you can install it and run it on the project to fix this failure.

"shares" is not meaningful to me. Maybe "percentages" would be more descriptive?

strengejacke · 2026-06-16T06:28:45Z

If N is included, percentages would not fit perfectly. I would say metrics (if N should be included) or percentages is fine.

elinw · 2026-06-18T00:22:19Z

If N is included, percentages would not fit perfectly. I would say metrics (if N should be included) or percentages is fine.

This sounds good. Can you let me know if N definitely should be included?
I'll do a commit for the name change alone first.

elinw · 2026-06-18T04:09:13Z

If N is included, percentages would not fit perfectly. I would say metrics (if N should be included) or percentages is fine.

This sounds good. Can you let me know if N definitely should be included? I'll do a commit for the name change alone first.

I added the "N" (in uppercase) option. I did have to change one additional function that assumed that the N column would be present. All of the tests still pass.

On the tests, the linter does not like testing for metrics = c(). I do think people will write that exactly so it's good to check, but identical(c(), NULL) is TRUE so technically it's a redundant test. Let me know what you think.

elinw · 2026-06-19T17:53:52Z

I think everything is resolved unless you have new requests.

etiennebacher · 2026-06-19T18:12:33Z

+#' @param metrics Optional character vector, indicating the types of
+#' percents to be included. Only applies to frequencies, i.e. when `by` is
+#' `NULL`. Can include any combination of `N` (frequencies including NA), `"raw"` (includes `NA` values),
+#' `"valid"` (excludes `NA` values) or `"cumulative"` (excludes `NA` values).
+#' Using `c()` will return a table with only the value labels. Invalid
+#' values (`metrics = "foo"`) are silently ignored.


Suggested change

#' @param metrics Optional character vector, indicating the types of

#' percents to be included. Only applies to frequencies, i.e. when `by` is

#' `NULL`. Can include any combination of `N` (frequencies including NA), `"raw"` (includes `NA` values),

#' `"valid"` (excludes `NA` values) or `"cumulative"` (excludes `NA` values).

#' Using `c()` will return a table with only the value labels. Invalid

#' values (`metrics = "foo"`) are silently ignored.

#' @param metrics Optional character vector, indicating the types of

#' metrics to be included. Only applies to frequencies, i.e. when `by` is

#' `NULL`. Can include any combination of `N` (frequencies including `NA`),

#' `"raw"` (percentage including `NA` values), `"valid"` (percentage excluding

#' `NA` values) or `"cumulative"` (percentage excluding `NA` values).

The part about silently ignoring unknown values seemed wrong (it errors) so I removed it.

etiennebacher · 2026-06-19T18:15:23Z

    }
    out <- cbind(var_info, out)
  }
+  total_n <- sum(out$N, na.rm = TRUE)


Why has this line moved? I don't think it causes an issue in itself but I'd rather minimize the git diff.

etiennebacher · 2026-06-19T18:20:08Z

Can you also resolve the conflicts?

elinw · 2026-06-21T18:08:40Z

I tried running Air on the file but the only issue it identified was duplicate blank lines. Not sure why this is failing.

etiennebacher · 2026-06-22T08:17:19Z

The problem was that a new version of Air was released a couple of days ago and replaces = by <- by default (when possible). This was clashing with our custom syntax that can be used in data_filter().

There are just the few comments above to resolve now (don't worry about linting failures).

elinw · 2026-06-23T00:56:49Z

The problem was that a new version of Air was released a couple of days ago and replaces = by <- by default (when possible). This was clashing with our custom syntax that can be used in data_filter().

There are just the few comments above to resolve now (don't worry about linting failures).

How about having a separate branch for those, since the comments are in unrelated files?

etiennebacher · 2026-06-23T07:44:09Z

Yes I have actually merged a PR that fixes those Air failures so that these changes don't appear here. Your latest commit message says you left questions on some comments but I don't see anything, am I missing something? I just want to avoid a situation where we're both waiting for something from the other.

elinw · 2026-06-23T12:56:53Z

Yes I have actually merged a PR that fixes those Air failures so that these changes don't appear here. Your latest commit message says you left questions on some comments but I don't see anything, am I missing something? I just want to avoid a situation where we're both waiting for something from the other.

I think, in the end, the only question I had was about metrics = "foo" and that doesn't matter.

etiennebacher · 2026-06-23T13:03:04Z

There are still unresolved comments above about docs/NEWS/line changed. I have made "suggestions" using Github interface but didn't actually apply them.

elinw · 2026-06-25T04:05:06Z

I'm not sure why two builds are failing, but they don't seem related. R crashed during the test of test-standardize_models.R: but it might be that retriggering the builds would fix. Not sure what would have changed.
R 4.6.1 was released today so I guess it couldbe related to that.

Update:

── Warning (test-standardize-data.R:23:1): standardize.numeric ─────────────────
Global state has changed:
names(before[[4]]) | names(after[[4]])
[79] "TESTTHAT" | "TESTTHAT" [79]
[80] "TESTTHAT_WD" | "TESTTHAT_WD" [80]
[81] "TMPDIR" | "TMPDIR" [81]
- "TZDIR" [82]
[82] "USER" | "USER" [83]
[83] "XPC_FLAGS" | "XPC_FLAGS" [84]
[84] "XPC_SERVICE_NAME" | "XPC_SERVICE_NAME" [85]
before[[4]][79:84] vs after[[4]][79:85]
TERM"xterm-256color"
TESTTHAT"true"
TESTTHAT_WD"/Users/elinwaring/Code/rcode/datawizard"
TMPDIR"/var/folders/gw/_qnrkpdn3fjg_0gwwnb9h_g40000gn/T/"

TZDIR"/var/db/timezone/zoneinfo"
USER"elinwaring"
XPC_FLAGS"0x0"
XPC_SERVICE_NAME"application.com.rstudio.desktop.371427447.371427452"
[ FAIL 0 | WARN 1 | SKIP 0 | PASS 75 ]

update 2

https://discourse.mc-stan.org/t/global-state-has-changed-warning/36591

Was this resolved for report?

update 3

Apparently the resolved this by deleting tests/testthat/helper-state.R

easystats/report#471

elinw added 2 commits June 11, 2026 21:52

Add measures parameter to control columns displayed in frequency tables.

6b4c2d2

Add a test for measures.

46a262b

strengejacke reviewed Jun 12, 2026

View reviewed changes

Comment thread R/data_tabulate.R Outdated

Comment thread R/data_tabulate.R Outdated

Comment thread tests/testthat/test-data_tabulate.R

strengejacke reviewed Jun 12, 2026

View reviewed changes

Comment thread R/data_tabulate.R Outdated

strengejacke requested a review from Copilot June 12, 2026 05:24

Copilot started reviewing on behalf of strengejacke June 12, 2026 05:24 View session

strengejacke mentioned this pull request Jun 12, 2026

describe_distribution(): How to omit Skewness and Kurtosis? #687

Open

This comment was marked as duplicate.

Sign in to view

etiennebacher requested changes Jun 12, 2026

View reviewed changes

elinw added 3 commits June 12, 2026 13:23

Add news, add example, fix spelling error and add a missing space.

591612a

Remove unneeded c().

8c530d9

Validate measures.

60e5b1a

elinw requested a review from etiennebacher June 12, 2026 19:07

fix indenting.

7c6542e

etiennebacher reviewed Jun 14, 2026

View reviewed changes

etiennebacher changed the title ~~Add measures parameter to control columns displayed in frequency tables.~~ Add measures parameter to data_tabulate() Jun 14, 2026

elinw added 2 commits June 15, 2026 16:40

Fix up examples and documentation.

477d16b

Add some more tests and update description.

e43eaea

elinw requested a review from etiennebacher June 15, 2026 21:44

elinw added 2 commits June 15, 2026 17:45

missing comma

b8a1757

update man pge

d8f4d1f

elinw added 2 commits June 17, 2026 21:10

Change measures to metrics.

43d9f13

Include "N" in the list of options for a frequency table metrics.

ee054e7

elinw changed the title ~~Add measures parameter to data_tabulate()~~ Add metrics parameter to data_tabulate() Jun 18, 2026

etiennebacher and others added 3 commits June 19, 2026 10:29

Merge branch 'main' into measures

3fe4d0e

Remove test for c() since it is the same as the one for NULL.

f758f63

Change = to <- (from linter)

abab8fa

etiennebacher requested changes Jun 19, 2026

View reviewed changes

elinw added 5 commits June 21, 2026 11:35

Resolve conflicts

d45d8dd

Resolve conflicts

5160de1

Resolve conflicts

d0c0f40

fix by test

258bd93

Air said to delete a line.

afa13d7

elinw requested a review from etiennebacher June 21, 2026 19:01

fix air

885a146

Merge branch 'main' into measures

3bcf5da

respond to some review comments (left questions on some others).

bcc8dd0

update news

04125a2

		#' `NULL`. Can be `"raw"` (includes `NA` values), `"valid"` (excludes `NA` values)
		#' or `"cumulative"` (excludes `NA` values).

		* `data_tabulate()` gain a `measures` argument to allow selection of columns to
		display ("raw", "valid", and "cumulative") (#689).

Uh oh!

Uh oh!

Conversation

elinw commented Jun 12, 2026 • edited by etiennebacher Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elinw commented Jun 12, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as duplicate.

Uh oh!

etiennebacher left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elinw commented Jun 12, 2026

Uh oh!

codecov Bot commented Jun 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

etiennebacher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

etiennebacher Jun 14, 2026

Choose a reason for hiding this comment

Uh oh!

elinw Jun 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

etiennebacher Jun 14, 2026

Choose a reason for hiding this comment

Uh oh!

elinw commented Jun 15, 2026

Uh oh!

strengejacke commented Jun 16, 2026

Uh oh!

elinw commented Jun 18, 2026

Uh oh!

elinw commented Jun 18, 2026

Uh oh!

elinw commented Jun 19, 2026

Uh oh!

etiennebacher Jun 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

etiennebacher Jun 19, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

etiennebacher commented Jun 19, 2026

Uh oh!

elinw commented Jun 21, 2026

Uh oh!

etiennebacher commented Jun 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

elinw commented Jun 23, 2026

Uh oh!

etiennebacher commented Jun 23, 2026

Uh oh!

elinw commented Jun 23, 2026

Uh oh!

etiennebacher commented Jun 23, 2026

Uh oh!

elinw commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

elinw commented Jun 12, 2026 •

edited by etiennebacher

Loading

etiennebacher left a comment •

edited

Loading

codecov Bot commented Jun 14, 2026 •

edited

Loading

etiennebacher Jun 19, 2026 •

edited

Loading

etiennebacher commented Jun 22, 2026 •

edited

Loading

elinw commented Jun 25, 2026 •

edited

Loading