pharmaverse / pharmaverse/rtables

Add information about the various possible formats in `?list_valid_format_labels()` as a new vignette section of rtables:format_precedence.

Open
#855 1 comment 0 reactions 1 assignee View on GitHub

@martincadek is already working on this.

Since Sep 12, 2024.

documentation enhancement sme
Dominant language
R
Stars
260
Forks
53
PR merge metrics
No merged PRs in 30d

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

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.