Package: SurrogateRank 3.0

SurrogateRank: Rank-Based Test to Evaluate a Surrogate Marker

Uses a novel rank-based nonparametric approach to evaluate a surrogate marker in a small sample size setting. Details are described in Parast et al (2024) <doi:10.1093/biomtc/ujad035>, in Hughes A et al (2025) <doi:10.1002/sim.70241>, and in Hughes A et al (2026) <doi:10.48550/arXiv.2605.03819>. A tutorial for this package can be found at <https://www.laylaparast.com/surrogaterank> and a Shiny App implementing the package can be found at <https://parastlab.shinyapps.io/SurrogateRankApp/>.

Authors:Layla Parast [aut, cre], Arthur Hughes [aut]

SurrogateRank_3.0.tar.gz
SurrogateRank_3.0.zip(r-4.7)SurrogateRank_3.0.zip(r-4.6)SurrogateRank_3.0.zip(r-4.5)
SurrogateRank_3.0.tgz(r-4.6-any)SurrogateRank_3.0.tgz(r-4.5-any)
SurrogateRank_3.0.tar.gz(r-4.7-any)SurrogateRank_3.0.tar.gz(r-4.6-any)
SurrogateRank_3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html
DESCRIPTION
card.svg |card.png
SurrogateRank/json (API)

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

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

Datasets:

On CRAN:

Conda:

4.43 score 2 stars 1 packages 1 scripts 266 downloads 14 exports 47 dependencies

Last updated from:c7c4b7fe54. Checks:9 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64OK136
source / vignettesOK189
linux-release-x86_64OK147
macos-release-arm64OK105
macos-oldrel-arm64OK97
windows-develOK111
windows-releaseOK100
windows-oldrelOK2990
wasm-releaseOK114

Exports:delta.calculatedelta.calculate.extensiondelta.reml.metaest.powergenerate.example.data.highdimgenerate.example.data.highdim.multistudygenerate.example.data.highdim.multistudy.ipdrise.evaluaterise.evaluate.metarise.screenrise.screen.metatest.surrogatetest.surrogate.extensiontest.surrogate.rise

Dependencies:admiscaplotclicolorspaceComplexUpsetcowplotcpp11digestdplyrfarverforcatsfsgenericsggfunggplot2ggplotifyggVennDiagramgluegridGraphicsgtableisobandlabelinglifecyclemagrittrMASSpatchworkpbmcapplypillarpkgconfigpurrrR6rappdirsRColorBrewerrlangS7scalesstringistringrtibbletidyrtidyselectutf8vctrsvennviridisLitewithryulab.utils

Readme and manuals

Help Manual

Help pageTopics
Calculates the rank-based test statistic for Y and S and the difference, deltadelta.calculate
Calculate Delta: Difference in Rank-based Statistics for Two Outcomesdelta.calculate.extension
Function to perform meta-analysis of summary statistics and hypothesis testing for a single markerdelta.reml.meta
Estimated power to detect a valid surrogateest.power
Example dataexample.data
High‑dimensional surrogate candidate example datasetexample.data.highdim
High-dimensional, multi-study surrogate candidate example datasetexample.data.highdim.multistudy
High‑dimensional multi-study individual participant surrogate candidate example datasetexample.data.highdim.multistudy.ipd
Generate individual participant data for high-dimensional surrogate candidates and responsegenerate.example.data.highdim
Generate high-dimensional multi-study surrogate marker trial-level effectsgenerate.example.data.highdim.multistudy
Generate multi-study individual participant data for high-dimensional surrogate candidates and responsegenerate.example.data.highdim.multistudy.ipd
Function to perform the evaluation stage of RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markersrise.evaluate
Function to perform the evaluation stage of RISE-meta : Meta-Analysis of High-Dimensional Surrogate Markersrise.evaluate.meta
Function to perform the screening stage of RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markersrise.screen
Function to perform the screening stage of RISE-meta : Meta-Analysis of High-Dimensional Surrogate Markersrise.screen.meta
Tests whether the surrogate is validtest.surrogate
Function to test for trial-level surrogacy of a single marker extended to the paired, two sided test settingtest.surrogate.extension
Function to perform RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markerstest.surrogate.rise