admiral icon indicating copy to clipboard operation
admiral copied to clipboard

Documentation: derive_vars_dt() clarify highest_imputation definitions, expand min dates example and add max dates example

Open bms63 opened this issue 4 months ago • 5 comments

Please select a category the issue is focused on?

Function Documentation

Let us know where something needs a refresh or put your idea here!

Could write in what n and Y mean here -

Image

I recognize they are right there in the Permitted Values, but I think this could help users understand that we don't mean No and Yes here, which is what happened with someone I was talking to.

Also - we don't have a max_dates examples.

The min_dates example has some really cool potential but is pretty minimal. We got the real estate can we add a few more records to showcase its abilities?

Definition of Done

  • [x] Functions argument where letters are specified, e.g. "Y" and "n" have the meanings of the letters explained next to them, i.e. If "n" (none, lowest level) is specified...
  • [x] The min_dates example has text corrected (see below comment) and is expanded to be more records/scenarios.
  • [x] A max_dates example is created that has similar records/scenarios.

bms63 avatar Aug 17 '25 19:08 bms63

I think improving the documentation is always a good idea.

The description of the min_dates example could also be refined. It says: "Note that the second record does not get imputed as it is before TRTSDTM.". This is not correct. The second record gets imputed but the restriction regarding min_dates is not applied because all possible imputed values are before the min date.

bundfussr avatar Aug 18 '25 12:08 bundfussr

@rameshpotluri1987 to take this on for mid Sept

manciniedoardo avatar Aug 18 '25 14:08 manciniedoardo

@bms63 to clean up the issue and add a few more details

manciniedoardo avatar Aug 18 '25 14:08 manciniedoardo

@rameshpotluri1987 will you be working on this issue still. I am happy to work on it.

bms63 avatar Oct 09 '25 18:10 bms63

@bms63. I could not get a chance to work on it yet, if that is okay, Can I complete it starting of next week.

potluri1987 avatar Oct 09 '25 18:10 potluri1987