#133 - Address comments about table and header

pharmaverse · Oct 28, 2022 · 0ad7f8f · 0ad7f8f
1 parent f8b9e2c
commit 0ad7f8f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -10,7 +10,7 @@ articles:
   release_strategy: release_strategy.html
   unit_test_guidance: unit_test_guidance.html
   writing_vignettes: writing_vignettes.html
-last_built: 2022-10-27T20:11Z
+last_built: 2022-10-28T17:09Z
 urls:
   reference: https://pharmaverse.github.io/admiraldev/devel/reference
   article: https://pharmaverse.github.io/admiraldev/devel/articles

diff --git a/vignettes/programming_strategy.Rmd b/vignettes/programming_strategy.Rmd
@@ -101,6 +101,9 @@ i.e. all input like datasets, variable names, options, … must be provided to t
 variables must start with `temp_` and must be removed from the output dataset.
 * If the input dataset includes variables starting with `temp_`, an error must be issued.
 * In general, the function must not have any side-effects like creating or modifying global objects, printing, writing files, ...
+
+## Admiral Options
+
 * An exception is made for admiral options, see `get_admiral_option()` and `set_admiral_options()`, where we have certain pre-defined defaults with added flexibility to allow for user-defined defaults on *commonly used* function arguments e.g. `subject_keys` currently pre-defined as `vars(STUDYID, USUBJID)`, but can be modified using `set_admiral_options(subject_keys = vars(...))` at the top of a script. The reasoning behind this was to relieve the user of repeatedly changing aforementioned *commonly used* function arguments multiple times in a script, which may be called across many admiral functions. 
 * If this additional flexibility needs to be added for another *commonly used* function argument e.g. `future_input` to be set as `vars(...)` it can be added as an admiral option. In the function formals define `future_input = get_admiral_option(future_input)` then proceed to modify the body and roxygen documentation of `set_admiral_options()`. 
 
@@ -205,10 +208,11 @@ Parameters which expect a boolean or boolean vector must start with a verb, e.g.
 | `filter`         | Expression to filter a dataset, e.g., `PARAMCD == "TEMP"`.                                                         |
 | `start_date`     | The start date of an event/interval. Expects a date object.                                                        |
 | `end_date`       | The end date of an event/interval. Expects a date object.                                                          |
-| `start_dtc`      | (Partial) start date/datetime in ISO 8601 format.                                                                                                                    |
+| `start_dtc`      | (Partial) start date/datetime in ISO 8601 format.                                                                  |
 | `dtc`            | (Partial) date/datetime in ISO 8601 format.                                                                        |
 | `date`           | Date of an event / interval. Expects a date object.                                                                |
 | `set_values_to`  | List of variable name-value pairs.                                                                                 |
+| `subject_keys`   | Variables to uniquely identify a subject, defaults to `vars(STUDYID, USUBJID)`. In function formals, use `subject_keys = get_admiral_option(subject_keys)`                                     |
 
 
 ## Source Code Formatting