search:

Skip to contents

Package index

Pre-Defined Objects

Objects defined by admiralonco that can be used as input for derivations

rsp_y no_data_n cb_y bor_cr bor_pr bor_sd bor_non_crpd bor_pd bor_ne no_data_missing crsp_y_cr crsp_y_pr cbor_cr cbor_pr
Pre-Defined Response Event Objects
death_event lastalive_censor pd_event lasta_censor rand_censor trts_censor
Pre-Defined Time-to-Event Source Objects

Utility Functions

Utilities for Formatting Observations

aval_resp()
Map Character Response Values to Numeric Values

Utilities for Dataset Checking

get_crpr_dataset()
Get CR Records Followed by PR That Lead to a Prior Error
signal_crpr()
Signal CR Records Followed by PR

Example Datasets

You can run admiral::use_ad_template() to produce additional datasets

admiral_adrs
Response Analysis Dataset

Deprecated

Functions and arguments may need to be removed or replaced over time. In such cases, the function or argument will enter a 3 year deprecation cycle. The cycle will be tied as close as sensibly possible to a package release.

When a function is deprecated:

  • In Year 1, there will be a message issued if you use the function/argument, but it will still be available to use.
  • In Year 2, a warning will be produced if you use the function/argument, but it will still be available to use.
  • In Year 3, an error will be produced if you use the function/argument and no longer be able to use.
  • Finally, after 3 years, the function/argument and related documentation and tests will be removed from admiral.

Note: Guidance on replacement functionality will be found in the message produced as well as in the function’s documentation.

Below, you can find a list of functions in the process of being deprecated:

date_source() deprecated
Create a date_source object

Superseded

Superseded functions have been replaced with more flexible functions that allow for construction of more diverse endpoints for a wider array of oncology indications, beyond solid tumor/RECIST. However, we will not be removing these functions from admiralonco in the near future and they will continue to be supported.

derive_param_bor() superseded
Adds a Parameter for Best Overall Response (without confirmation)
derive_param_clinbenefit() superseded
Adds a Parameter for Clinical Benefit
derive_param_confirmed_bor() superseded
Adds a Parameter for Confirmed Best Overall Response
derive_param_confirmed_resp() superseded
Adds a Parameter for Confirmed Response
derive_param_response() superseded
Adds a Parameter Indicating If a Subject Had a Response before Progressive Disease
filter_pd() superseded
Filter up to First PD (Progressive Disease) Date