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-any)SurrogateRank_3.0.zip(r-4.6-any)SurrogateRank_3.0.zip(r-4.5-any)
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:

example.data - Example data
example.data.highdim - High‑dimensional surrogate candidate example dataset
example.data.highdim.multistudy - High-dimensional, multi-study surrogate candidate example dataset
example.data.highdim.multistudy.ipd - High‑dimensional multi-study individual participant surrogate candidate example dataset

On CRAN:

4.32 score 2 stars 1 packages 5 scripts 384 downloads 14 exports 47 dependencies

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

Target	Result	Time
linux-devel	OK	157
source / vignettes	OK	186
linux-release	OK	192
macos-release	OK	119
macos-oldrel	OK	98
windows-devel	OK	102
windows-release	OK	102
windows-oldrel	OK	84
wasm-release	OK	114

Exports:delta.calculate delta.calculate.extension delta.reml.meta est.power generate.example.data.highdim generate.example.data.highdim.multistudy generate.example.data.highdim.multistudy.ipd rise.evaluate rise.evaluate.meta rise.screen rise.screen.meta test.surrogate test.surrogate.extension test.surrogate.rise

Dependencies:admisc aplot cli colorspace ComplexUpset cowplot cpp11 digest dplyr farver forcats fs generics ggfun ggplot2 ggplotify ggVennDiagram glue gridGraphics gtable isoband labeling lifecycle magrittr MASS patchwork pbmcapply pillar pkgconfig purrr R6 rappdirs RColorBrewer rlang S7 scales stringi stringr tibble tidyr tidyselect utf8 vctrs venn viridisLite withr yulab.utils

Citation

Development and contributors

Readme and manuals

Help Manual

Help page	Topics
Calculates the rank-based test statistic for Y and S and the difference, delta	delta.calculate
Calculate Delta: Difference in Rank-based Statistics for Two Outcomes	delta.calculate.extension
Function to perform meta-analysis of summary statistics and hypothesis testing for a single marker	delta.reml.meta
Estimated power to detect a valid surrogate	est.power
Example data	example.data
High‑dimensional surrogate candidate example dataset	example.data.highdim
High-dimensional, multi-study surrogate candidate example dataset	example.data.highdim.multistudy
High‑dimensional multi-study individual participant surrogate candidate example dataset	example.data.highdim.multistudy.ipd
Generate individual participant data for high-dimensional surrogate candidates and response	generate.example.data.highdim
Generate high-dimensional multi-study surrogate marker trial-level effects	generate.example.data.highdim.multistudy
Generate multi-study individual participant data for high-dimensional surrogate candidates and response	generate.example.data.highdim.multistudy.ipd
Function to perform the evaluation stage of RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markers	rise.evaluate
Function to perform the evaluation stage of RISE-meta : Meta-Analysis of High-Dimensional Surrogate Markers	rise.evaluate.meta
Function to perform the screening stage of RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markers	rise.screen
Function to perform the screening stage of RISE-meta : Meta-Analysis of High-Dimensional Surrogate Markers	rise.screen.meta
Tests whether the surrogate is valid	test.surrogate
Function to test for trial-level surrogacy of a single marker extended to the paired, two sided test setting	test.surrogate.extension
Function to perform RISE : Two-Stage Rank-Based Identification of High-Dimensional Surrogate Markers	test.surrogate.rise