Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General Issue: Update ... and args to sources in admiral-class based functions #2023

Closed
zdz2101 opened this issue Jul 20, 2023 · 2 comments
Closed
Assignees
Labels
function re-work issues identified by function re-work gang - usually argument alignment, user friendliness general issue

Comments

@zdz2101
Copy link
Collaborator

zdz2101 commented Jul 20, 2023

Background Information

As part of our efforts to get to a 1.0 version of admiral, we are looking over all functions for consistency and user-friendliness.

Several functions use ... or args to call upon a list of admiral-specific class (usually xxx_source) objects: e.g. date_source dthcaus_source records_source etc. The following functions are affected:

  • call_derivation()
  • derive_var_dthcaus()
  • derive_var_extreme_dt()
  • derive_var_extreme_dtm()
  • params()
  • slice_derivation()
  • derivation_slice()
  • restrict_derivation()
  • slice_derivation()

Definition of Done

Add sources as a function argument and begin the deprecation process of ... and args for the above functions

@bundfussr
Copy link
Collaborator

I think param() should not be changed.

I would wait until we have cleaned up the functions before implementing this issue. In particular derive_var_dthcaus(), derive_var_extreme_dt(), and derive_var_extreme_dtm() are questionable because they are very similar.

@bms63 bms63 added the function re-work issues identified by function re-work gang - usually argument alignment, user friendliness label Jul 24, 2023
@bms63
Copy link
Collaborator

bms63 commented Nov 6, 2023

Converting back to discussion. I think after the documentation review we should revisit this topic. @manciniedoardo @bundfussr @ddsjoberg @zdz2101

@pharmaverse pharmaverse locked and limited conversation to collaborators Nov 6, 2023
@bms63 bms63 converted this issue into discussion #2219 Nov 6, 2023

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
function re-work issues identified by function re-work gang - usually argument alignment, user friendliness general issue
Development

No branches or pull requests

3 participants