pharmaverse / pharmaverse/formatters
Better documentation for function insertion in the format value (e.g. `sprintf` cooperation)
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 20
- Forks
- 8
- Avg merge
- 12h 28m
- Merged PRs (30d)
- 1
Description
I think this is one of the best features in customizing rtables values. We should allow users to know this more readily. I propose to extend examples in function sprintf_format and add @seealso to list_valid_format* with that function and round_fmt. It is also necessary imo to have a short explanation at the end of function call list_valid_format* that explains the possibility to use dynamic function calls to set the format.
Tracked by https://github.com/insightsengineering/rtables/issues/611
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.
Research direction
Start by reading the documentation for sprintf_format, list_valid_format* and round_fmt. Extend the sprintf_format examples, add the requested @seealso references, and add a short explanation to list_valid_format* about dynamic function calls for setting formats. Check the tracked issue 611 before starting, since this work may have moved there.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100