diff --git a/vignettes/programming_strategy.Rmd b/vignettes/programming_strategy.Rmd index 1bf4101a..724f20f4 100644 --- a/vignettes/programming_strategy.Rmd +++ b/vignettes/programming_strategy.Rmd @@ -208,15 +208,16 @@ Arguments which expect a boolean or boolean vector must start with a verb, e.g., Arguments which only expect one value or variable name must be a singular version of the word(s), e.g., `missing_value` or `new_var`. Arguments which expect several values or variable names (as a list, expressions, etc.) must be a plural version of the word(s), e.g., `missing_values` or `new_vars`. ## List of Common Arguments - -| Argument Name | Description | +| Argument Name | Description | |------------------|--------------------------------------------------------------------------------------------------------------------| | `dataset` | The input dataset. Expects a data.frame or a tibble. | +| `dataset_ref` | The reference dataset, e.g. ADSL. Typically includes just one observation per subject. | +| `dataset_add` | An additional dataset. Used in some `derive_xx` and `filter_xx` functions to access variables from an additional dataset. | | `by_vars` | Variables to group by. | -| `order` | List of expressions for sorting a dataset, e.g., `exprs(PARAMCD, AVISITN, desc(AVAL))`. | +| `order` | List of expressions for sorting a dataset, e.g., `exprs(PARAMCD, AVISITN, desc(AVAL))`. | | `new_var` | Name of a single variable to be added to the dataset. | | `new_vars` | List of variables to be added to the dataset. | -| `new_var_unit` | Name of the unit variable to be added. It should be the unit of the variable specified for the `new_var` argument. | +| `new_var_unit` | Name of the unit variable to be added. It should be the unit of the variable specified for the `new_var` argument. | | `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. | @@ -226,7 +227,7 @@ Arguments which only expect one value or variable name must be a singular versio | `set_values_to` | List of variable name-value pairs. Use `process_set_values_to()` for processing the value and providing user friendly error messages. | | `subject_keys` | Variables to uniquely identify a subject, defaults to `exprs(STUDYID, USUBJID)`. In function formals, use `subject_keys = get_admiral_option("subject_keys")` | | `keep_source_vars` | Specifies which variables from the selected observations should be kept. The default of the argument should be `everything()`. | -| `missing_value` | A singular value to be entered if the data is missing. | +| `missing_value` | A singular value to be entered if the data is missing. | | `missing_values` | A named list of expressions where the names are variables in the dataset and the values are a value to be entered if the data is missing, e.g., `exprs(BASEC = "MISSING", BASE = -1)`. | ## Source Code Formatting