Add information about the various possible formats in `?list_valid_format_labels()` as a new vignette section of rtables:format_precedence.
@martincadek is already working on this.
Since Sep 12, 2024.
Assessment
This issue has not been assessed yet.
Description
We need to add information about the various possible formats in `?list_valid_format_labels()` and in {rtables} with a looot of examples. If you do `?rtables::analyze` you will find the format parameter defined as such:
format | FormatSpec. Format associated with this split. Formats can be declared via strings ("xx.x") or function. In cases such as analyze calls, they can character vectors or lists of functions.
But as you can see there are no links to other docs or functions that lists useful formats. We should enhance the network of @seealso by adding these info in a common place (I would opt for ?list_formats) that is linked from many {rtables} functions (the one that have format as argument ideally, while list_formats keeps connection to other formatting functions. Final examples (not to have circular deps) should live in a dedicated vignette in {rtables} along with the format handling/precedence
Originally posted by @Melkiades in https://github.com/insightsengineering/formatters/pull/269#pullrequestreview-1952875460 ; specifically here.
The new vignette should be part of https://github.com/insightsengineering/rtables/blob/main/vignettes/format_precedence.Rmd
- Dominant language
- R
- Stars
- 260
- Forks
- 53
- PR merge metrics
- No merged PRs in 30d
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.
More from pharmaverse/rtables
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
pharmaverse/rtables#1123 · 1 comment · 1 reaction ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
pharmaverse/rtables#1107 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
pharmaverse/rtables#1105 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
pharmaverse/rtables#1096 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
pharmaverse/rtables#1121 ·
All issues in pharmaverse/rtables
Similar issues
-
Difficulty 2/5 Half a day Newbie friendliness 78/100
ThinkR-open/datadiff#59 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
tidymodels/parsnip#1444 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
priority: should UX
Difficulty 2/5 1-3 hours Newbie friendliness 72/100