pharmaverse / pharmaverse/formatters

Section name lab_name: Name is confusing

Open
#114 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question sme
Dominant language
R
Stars
20
Forks
8
Avg merge
12h 28m
Merged PRs (30d)
1

Description

Section: lab_name

The name of this section can be confusing: clinical trials can involve labs. Some R functions may contain the argument "lab", but it is not associated with "name".

Solution

Name could be changed to "label_name" or "lbl_name" or "name.lbl":

  • the "label" keyword is already used for some functions;
  • "lbl" is shorter, while less likely to be confused;
  • name.lbl or names.lbl: can benefit from the tools available for generic functions in R;

Note:

  • generic functions can be easily searched in R using the methods function:

names.lbl = function(x) print(x); # just some test
methods(names)
# [1] names.lbl names.POSIXlt

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.

Research direction

Start by locating the definition and all uses of the lab_name section, then inspect the R naming conventions and the methods() example in the issue. Resolve which proposed replacement the project wants, update every affected reference consistently, and verify that existing formatting behavior and documentation remain correct.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.