Documentation: Explain subject_keys option in programming strategy

[rossfarrugia]

Please select a category the issue is focused on?

Developer Guides

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

In admiraldev programming strategy vignette add a sentence to cover the decisions from pharmaverse/admiral#1338 so that anyone creating a new function knows to follow this convention.

[zdz2101]

Do you have a recommendation where this snippet should be placed? Perhaps under Input, Output, and Side-effects?

Thinking we might need more than a sentence, maybe something along the lines of this:

[rossfarrugia]

@bundfussr any suggestions?? i'm personally ok with using the Input, Output, and Side-effects section.

i like your suggested wordings and extra detail @zdz2101 and this will act as a good reminder if ever we do need to come back and extend this later.

i'd also suggest we add subject_keys to the table at https://pharmaverse.github.io/admiraldev/devel/articles/programming_strategy.html#list-of-common-parameters reminding developers of this default value here - for me that's the most important reminder as i bet many new functions will get developed and people will forget to use this default (although hopefully if they just copy another function as a starting point they won't anyway).

[bundfussr]

@zdz2101 , @rossfarrugia , I would

• add subject_keys to the table as Ross suggested,
• update the last item in "Input, Output, and Side-effects" as Zelos suggested ("In general, the function must not have any side-effects ..."),
• move the other two items to a separate top level section ("admiral Options").