Surrogate3.4.1 package

Evaluation of Surrogate Endpoints in Clinical Trials

AA.MultS

Compute the multiple-surrogate adjusted association

association_gof_copula

Produce Associational GoF plot

BifixedContCont

Fits a bivariate fixed-effects model to assess surrogacy in the meta-a...

BimixedCbCContCont

Fits a bivariate mixed-effects model using the cluster-by-cluster (CbC...

BimixedContCont

Fits a bivariate mixed-effects model to assess surrogacy in the meta-a...

binary_continuous_loglik

Loglikelihood function for binary-continuous copula model

Bootstrap.MEP.BinBin

Bootstrap 95% CI around the maximum-entropy ICA and SPF (surrogate pre...

CausalDiagramBinBin

Draws a causal diagram depicting the median informational coefficients...

CausalDiagramContCont

Draws a causal diagram depicting the median correlations between the c...

cdf_fun

Function factory for distribution functions

clayton_loglik_copula_scale

Loglikelihood on the Copula Scale for the Clayton Copula

colorectal.rd

The Colorectal dataset with a binary surrogate.

colorectal4.rd

The Colorectal dataset with an ordinal surrogate.

comb27.BinBin

Assesses the surrogate predictive value of each of the 27 prediction f...

compute_ICA_BinCont

Compute Individual Causal Association for a given D-vine copula model ...

compute_ICA_ContCont

Compute Individual Causal Association for a given D-vine copula model ...

compute_ICA_OrdCont

Compute Individual Causal Association for a given D-vine copula model ...

compute_ICA_OrdOrd

Compute Individual Causal Association for a given D-vine copula model ...

compute_ICA_SurvSurv

Compute Individual Causal Association for a given D-vine copula model ...

compute_ICA

Compute Individual Causal Association for a given D-vine copula model ...

constructor_ICA_estimator

Function constructor to estimate the ICA given a set of sampled patien...

continuous_continuous_loglik

Loglikelihood function for continuous-continuous copula model

delta_method_log_mutinfo

Variance of log-mutual information based on the delta method

Dvine_ICA_confint

Confidence interval for the ICA given the unidentifiable parameters

ECT

Apply the Entropy Concentration Theorem

estimate_ICA_BinCont

Estimate ICA in Binary-Continuous Setting

estimate_ICA_ContCont

Estimate ICA in Ordinal-Ordinal Setting

estimate_ICA_OrdCont

Estimate ICA in Ordinal-Continuous Setting

estimate_ICA_OrdOrd

Estimate ICA in Ordinal-Ordinal Setting

estimate_marginal

Estimate marginal distribution using ML

estimate_mutual_information_SurvSurv

Estimate the Mutual Information in the Survival-Survival Setting

Fano.BinBin

Evaluate the possibility of finding a good surrogate in the setting wh...

FederatedApproachStage1

Fits the first stage model in the two-stage federated data analysis ap...

FederatedApproachStage2

Fits the second stage model in the two-stage federated data analysis a...

fit_copula_ContCont

Fit continuous-continuous vine copula model

fit_copula_model_BinCont

Fit copula model for binary true endpoint and continuous surrogate end...

fit_copula_OrdCont

Fit ordinal-continuous vine copula model

fit_copula_OrdOrd

Fit ordinal-ordinal vine copula model

fit_copula_submodel_BinCont

Fit binary-continuous copula submodel

fit_copula_submodel_ContCont

Fit ordinal-continuous copula submodel

fit_copula_submodel_OrdCont

Fit ordinal-continuous copula submodel

fit_copula_submodel_OrdOrd

Fit ordinal-continuous copula submodel

fit_model_SurvSurv

Fit Survival-Survival model

FixedBinBinIT

Fits (univariate) fixed-effect models to assess surrogacy in the binar...

FixedBinContIT

Fits (univariate) fixed-effect models to assess surrogacy in the case ...

FixedContBinIT

Fits (univariate) fixed-effect models to assess surrogacy in the case ...

FixedContContIT

Fits (univariate) fixed-effect models to assess surrogacy in the conti...

FixedDiscrDiscrIT

Investigates surrogacy for binary or ordinal outcomes using the Inform...

frank_loglik_copula_scale

Loglikelihood on the Copula Scale for the Frank Copula

gaussian_loglik_copula_scale

Loglikelihood on the Copula Scale for the Gaussian Copula

gumbel_loglik_copula_scale

Loglikelihood on the Copula Scale for the Gumbel Copula

ICA_alpha_ContCont

Assess surrogacy using a Rényi divergence based family of metrics in t...

ICA_given_model_constructor_SurvSurv

Constructor for the function that returns that ICA as a function of th...

ICA_given_model_constructor

Constructor for the function that returns that ICA as a function of th...

ICA_t

The function ICA_t() is to evaluate surrogacy in the single-trial ca...

ICA.BinBin.Grid.Full

Assess surrogacy in the causal-inference single-trial setting in the b...

ICA.BinBin.Grid.Sample

Assess surrogacy in the causal-inference single-trial setting in the b...

ICA.BinBin.Grid.Sample.Uncert

Assess surrogacy in the causal-inference single-trial setting in the b...

ICA.BinCont.BS

Assess surrogacy in the causal-inference single-trial setting in the b...

ICA.ContCont.Mult_alt

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICA.ContCont.MultS.MPC

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICA.ContCont.MultS.PC

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICA.ContCont.MultS

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICA.Sample.ContCont

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICA.Sample.ControlTreat

Assess surrogacy in the causal-inference single-trial setting (Individ...

ICABinBin

Assess surrogacy in the causal-inference single-trial setting in the b...

ICABinBinCounterAssum

ICA (binary-binary setting) that is obtaied when the counterfactual co...

ICABinCont

Assess surrogacy in the causal-inference single-trial setting in the b...

ICAContCont

Assess surrogacy in the causal-inference single-trial setting (Individ...

ISTE.ContCont

Individual-level surrogate threshold effect for continuous normally di...

log_likelihood_copula_model

Computes loglikelihood for a given copula model

loglik_copula_scale

Loglikelihood on the Copula Scale

LongToWide

Reshapes a dataset from the 'long' format (i.e., multiple lines per pa...

marginal_distribution

Fit marginal distribution

marginal_gof_copula

Produce marginal GoF plot

marginal_gof_plots_scr

Marginal survival function goodness of fit

marginal_gof_scr_S_plot

Goodness-of-fit plot for the marginal survival functions

MarginalProbs

Computes marginal probabilities for a dataset where the surrogate and ...

MaxEntICABinBin

Use the maximum-entropy approach to compute ICA in the binary-binary s...

MaxEntICAContCont

Use the maximum-entropy approach to compute ICA in the continuous-cont...

MaxEntSPFBinBin

Use the maximum-entropy approach to compute SPF (surrogate predictive ...

mean_S_before_T_plot_scr

Goodness of fit plot for the fitted copula

MetaAnalyticSurvBin

Compute surrogacy measures for a binary surrogate and a time-to-event ...

MetaAnalyticSurvCat

Compute surrogacy measures for a categorical (ordinal) surrogate and a...

MetaAnalyticSurvCont

Compute surrogacy measures for a continuous (normally-distributed) sur...

MetaAnalyticSurvSurv

Compute surrogacy measures for a time-to-event surrogate and a time-to...

MICA.Sample.ContCont

Assess surrogacy in the causal-inference multiple-trial setting (Meta-...

MICAContCont

Assess surrogacy in the causal-inference multiple-trial setting (Meta-...

MinSurrContCont

Examine the plausibility of finding a good surrogate endpoint in the C...

MixedContContIT

Fits (univariate) mixed-effect models to assess surrogacy in the conti...

model_fit_measures

Goodness of fit information for survival-survival model

MufixedContCont.MultS

Fits a multivariate fixed-effects model to assess surrogacy in the met...

MumixedContCont.MultS

Fits a multivariate mixed-effects model to assess surrogacy in the met...

new_vine_copula_fit

Constructor for vine copula model

new_vine_copula_ss_fit

Constructor for vine copula model

ordinal_continuous_loglik

Loglikelihood function for ordinal-continuous copula model

ordinal_ordinal_loglik

Loglikelihood function for ordinal-ordinal copula model

ordinal_to_cutpoints

Convert Ordinal Observations to Latent Cutpoints

pdf_fun

Function factory for density functions

plot.CausalInference

Plots the (Meta-Analytic) Individual Causal Association when S and T a...

plot.comb27.BinBin

Plots the distribution of prediction error functions in decreasing ord...

plot.Fano.BinBin

Plots the distribution of RHL2R^2_{HL} either as a density or as functio...

Plot.FixedDiscrDiscrIT

Provides plots of trial-level surrogacy in the Information-Theoretic f...

plot.ICA.BinCont

Plot the individual causal association (ICA) in the causal-inference s...

plot.ICA.ContCont.Mult

Plots the Individual Causal Association in the setting where there are...

plot.ICABinBin

Plots the (Meta-Analytic) Individual Causal Association and related me...

plot.InformationTheoretic

Provides plots of trial- and individual-level surrogacy in the Informa...

plot.InformationTheoreticBinCombn

Provides plots of trial- and individual-level surrogacy in the Informa...

plot.InformationTheoreticSurvSurv

Provides plots of trial- and individual-level surrogacy in the Informa...

plot.ISTE.ContCont

Plots the individual-level surrogate threshold effect (STE) values and...

plot.MaxEntContCont

Plots the sensitivity-based and maximum entropy based Individual Causa...

plot.MaxEntICABinBin

Plots the sensitivity-based and maximum entropy based Individual Causa...

plot.MaxEntSPFBinBin

Plots the sensitivity-based and maximum entropy based surrogate predic...

plot.MetaAnalytic

Provides plots of trial- and individual-level surrogacy in the meta-an...

plot.MetaAnalyticSurvBin

Generates a plot of the estimated treatment effects for the surrogate ...

plot.MetaAnalyticSurvCat

Generates a plot of the estimated treatment effects for the surrogate ...

plot.MetaAnalyticSurvCont

Generates a plot of the estimated treatment effects for the surrogate ...

plot.MetaAnalyticSurvSurv

Generates a plot of the estimated treatment effects for the surrogate ...

plot.MinSurrContCont

Graphically illustrates the theoretical plausibility of finding a good...

plot.PPE.BinBin

Plots the distribution of either PPEPPE, RPERPE or RH2R^2_{H} either as a...

Plot.PredTrialTContCont

Plots the expected treatment effect on the true endpoint in a new tria...

plot.SPF.BinCont

Plot the surrogate predictive function (SPF) in the causal-inference s...

plot.SPPBinBin

Plots the surrogate predictive function (SPF) in the binary-binary set...

plot.TrialLevelIT

Provides a plots of trial-level surrogacy in the information-theoretic...

plot.TrialLevelMA

Provides a plots of trial-level surrogacy in the meta-analytic framewo...

plot.TwoStageSurvSurv

Plots trial-level surrogacy in the meta-analytic framework when two su...

plot.vine_copula_fit

Goodness-of-fit plots for the fitted copula models

Pos.Def.Matrices

Generate 4 by 4 correlation matrices and flag the positive definite on...

PPE.BinBin

Evaluate a surrogate predictive value based on the minimum probability...

Pred.TrialT.ContCont

Compute the expected treatment effect on the true endpoint in a new tr...

Prentice

Evaluates surrogacy based on the Prentice criteria for continuous endp...

print.MetaAnalyticSurvBin

Prints all the elements of an object fitted with the 'MetaAnalyticSurv...

print.MetaAnalyticSurvCat

Prints all the elements of an object fitted with the 'MetaAnalyticSurv...

print.MetaAnalyticSurvCont

Prints all the elements of an object fitted with the 'MetaAnalyticSurv...

print.MetaAnalyticSurvSurv

Prints all the elements of an object fitted with the 'MetaAnalyticSurv...

print.vine_copula_fit

Print summary of fitted copula model

PROC.BinBin

Evaluate the individual causal association (ICA) and reduction in prob...

RandVec

Generate random vectors with a fixed sum

Restrictions.BinBin

Examine restrictions in πf\bold{\pi}_{f} under different montonicity a...

sample_copula_parameters

Sample Unidentifiable Copula Parameters

sample_deltas_BinCont

Sample individual casual treatment effects from given D-vine copula mo...

sample_dvine

Sample copula data from a given four-dimensional D-vine copula

sensitivity_analysis_BinCont_copula

Perform Sensitivity Analysis for the Individual Causal Association wit...

sensitivity_analysis_copula

Perform Sensitivity Analysis for the Individual Causal Association bas...

sensitivity_analysis_SurvSurv_copula

Sensitivity analysis for individual causal association

sensitivity_intervals_Dvine

Compute Sensitivity Intervals

Sim.Data.Counterfactuals

Simulate a dataset that contains counterfactuals

Sim.Data.CounterfactualsBinBin

Simulate a dataset that contains counterfactuals for binary endpoints

Sim.Data.MTS

Simulates a dataset that can be used to assess surrogacy in the multip...

Sim.Data.STS

Simulates a dataset that can be used to assess surrogacy in the single...

Sim.Data.STSBinBin

Simulates a dataset that can be used to assess surrogacy in the single...

Single.Trial.RE.AA

Conducts a surrogacy analysis based on the single-trial meta-analytic ...

SPF.BinCont

Evaluate the surrogate predictive function (SPF) in the causal-inferen...

SPP.BinBin

Evaluate the surrogate predictive function (SPF) in the binary-binary ...

summary_level_bootstrap_ICA

Bootstrap based on the multivariate normal sampling distribution

summary.FederatedApproachStage2

Provides a summary of the surrogacy measures for an object fitted with...

summary.gen

Summary

summary.MetaAnalyticSurvBin

Provides a summary of the surrogacy measures for an object fitted with...

summary.MetaAnalyticSurvCat

Provides a summary of the surrogacy measures for an object fitted with...

summary.MetaAnalyticSurvCont

Provides a summary of the surrogacy measures for an object fitted with...

summary.MetaAnalyticSurvSurv

Provides a summary of the surrogacy measures for an object fitted with...

Surrogate-package

Surrogate: Evaluation of Surrogate Endpoints in Clinical Trials

SurvSurv

Assess surrogacy for two survival endpoints based on information theor...

Test.Mono

Test whether the data are compatible with monotonicity for S and/or T ...

TrialLevelIT

Estimates trial-level surrogacy in the information-theoretic framework

TrialLevelMA

Estimates trial-level surrogacy in the meta-analytic framework

TwoStageSurvSurv

Assess trial-level surrogacy for two survival endpoints using a two-st...

twostep_BinCont

Fit binary-continuous copula submodel with two-step estimator

twostep_SurvSurv

Fit survival-survival copula submodel with two-step estimator

UnifixedContCont

Fits univariate fixed-effect models to assess surrogacy in the meta-an...

UnimixedContCont

Fits univariate mixed-effect models to assess surrogacy in the meta-an...

In a clinical trial, it frequently occurs that the most credible outcome to evaluate the effectiveness of a new therapy (the true endpoint) is difficult to measure. In such a situation, it can be an effective strategy to replace the true endpoint by a (bio)marker that is easier to measure and that allows for a prediction of the treatment effect on the true endpoint (a surrogate endpoint). The package 'Surrogate' allows for an evaluation of the appropriateness of a candidate surrogate endpoint based on the meta-analytic, information-theoretic, and causal-inference frameworks. Part of this software has been developed using funding provided from the European Union's Seventh Framework Programme for research, technological development and demonstration (Grant Agreement no 602552), the Special Research Fund (BOF) of Hasselt University (BOF-number: BOF2OCPO3), GlaxoSmithKline Biologicals, Baekeland Mandaat (HBC.2022.0145), and Johnson & Johnson Innovative Medicine.

  • Maintainer: Wim Van Der Elst
  • License: GPL (>= 2)
  • Last published: 2025-04-29