Package: SurrogateOutcome 1.2

SurrogateOutcome: Estimation of the Proportion of Treatment Effect Explained by Surrogate Outcome Information

Provides functions to estimate the proportion of treatment effect on a censored primary outcome that is explained by the treatment effect on a censored surrogate outcome/event. All methods are described in detail in Parast, et al (2020) "Assessing the Value of a Censored Surrogate Outcome" <doi:10.1007/s10985-019-09473-1> and Wang et al (2025) "Model-free Approach to Evaluate a Censored Intermediate Outcome as a Surrogate for Overall Survival" (Under Review) <doi:10.48550/arXiv.2412.14129>. A tutorial for this package can be found at <https://www.laylaparast.com/surrogateoutcome>.

Authors:Layla Parast [aut, cre], Xuan Wang [aut]

SurrogateOutcome_1.2.tar.gz
SurrogateOutcome_1.2.zip(r-4.7-any)SurrogateOutcome_1.2.zip(r-4.6-any)SurrogateOutcome_1.2.zip(r-4.5-any)
SurrogateOutcome_1.2.tgz(r-4.6-any)SurrogateOutcome_1.2.tgz(r-4.5-any)
SurrogateOutcome_1.2.tar.gz(r-4.7-any)SurrogateOutcome_1.2.tar.gz(r-4.6-any)
SurrogateOutcome_1.2.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION
card.svg |card.png
SurrogateOutcome/json (API)

# Install 'SurrogateOutcome' in R:
install.packages('SurrogateOutcome', repos = c('https://laylaparast.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/laylaparast/surrogateoutcome/issues

Datasets:

On CRAN:

Conda:

3.00 score 282 downloads 9 exports 3 dependencies

Last updated from:56e7e3932b. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK103
source / vignettesOK159
linux-releaseOK99
macos-releaseOK95
macos-oldrelOK80
windows-develOK85
windows-releaseOK80
windows-oldrelOK79
wasm-releaseOK89

Exports:censor.weightdelta.estimatedelta.q.event.RMSTdelta.q.event.semi.RMSTdelta.t.RMSTIV.eventR.opt.eventR.q.eventR.t.estimate

Dependencies:latticeMatrixsurvival

Readme and manuals

Help Manual

Help pageTopics
Estimates the treatment effect at time t, defined as the difference in the restricted mean survival timedelta.estimate
Calculates the residual treatment effect (the difference in restricted mean survival time at time t) after accounting for the treatment effect on the surrogate outcome information up to the landmark timedelta.q.event.RMST
Calculates the residual treatment effect (the difference in restricted mean survival time at time t) after accounting for the treatment effect on the surrogate outcome information up to the landmark timedelta.q.event.semi.RMST
Calculates the residual treatment effect (the difference in restricted mean survival time at time t) after accounting for the treatment effect on the primary outcome up to the landmark timedelta.t.RMST
Hypothetical dataExampleData
Calculates the incremental value of the surrogate outcome informationIV.event
Calculates the proportion of the treatment effect (the difference in survival at time t) explained by surrogate outcome information observed up to the landmark time, using the optimal transformation of the surrogateR.opt.event
Calculates the proportion of the treatment effect (the difference in restriced mean survival time at time t) explained by surrogate outcome information observed up to the landmark timeR.q.event
Calculates the proportion of the treatment effect (the difference in restricted mean survival time at time t) explained by primary outcome information observed up to the landmark timeR.t.estimate