R Observatory: Metrics for SurrogateOutcome version 1.2

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

SurrogateOutcome

1.2

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

0packages depend

2.4Kdownloads / year

–test coverage

13/13checks pass

Overview

About

Maintained by Layla ParastFirst published 2019-04-093 releasesCRAN page ↗

Estimates 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" doi:10.1002/sim.70268. A tutorial for this package can be found at https://www.laylaparast.com/surrogateoutcome.

Install

R (CRAN)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("SurrogateOutcome", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-surrogateoutcome

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-SurrogateOutcome

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-SurrogateOutcome

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed).

Health

CRAN checks

13OK

Slowest check: 2.2 min · r-oldrel-macos-x86_64

Code health

None

Tests · ratio 0.00

not tracked

Coverage

100%

Documentation · exports

2

Dependencies · direct

Check history

OK2026-08-05
13 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
NOTE2026-08-01
12 OK · 1 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE
OK2026-03-10
14 OK · 0 NOTE · 0 WARNING · 0 ERROR · 0 FAILURE

Documentation

READMENoVignettesNopkgdown siteNoNEWSNoCode of conductNoContributing guideNo

Examples that run: 100%
Documented parameters: 100%
Return-value docs: 100%
References docs: 40%

Downloads

2.4K

CRAN downloads in the past year

Rank #18,732 · ~7/day · ~201/mo

Releases R versions

Daily download trend is not available in this view yet.

15830 days

60090 days

2.4K1 year

Compare downloads with other packages →

Also on110 r2u25 autocran

Dependencies

Declared dependencies

0 external dependencies (excludes base and recommended)

Depends (0)

none

Imports (2)

statssurvival

LinkingTo (0)

none

Suggests (0)

none

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

Code & Tests

Datasets

People & History

People (2)

Maintainer (1)

Layla Parast

Author, Maintainer

Authors (2)

Layla Parast

Author, Maintainer

Xuan Wang

Author · added in 1.2

Package Timeline

3 releases. Pick two to compare their code metrics. R releases are shown for context.

R
R 4.6.0 released · 2026-04-24
1.2Latest
2025-11-07 · current release · diff ↗
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
R
R 4.3.0 released · 2023-04-21
R
R 4.2.0 released · 2022-04-22
1.1
2021-11-15 · diff ↗
R
R 4.1.0 released · 2021-05-18
R
R 4.0.0 released · 2020-04-24
R
R 3.6.0 released · 2019-04-26
1.0
2019-04-09
R
R 3.5.0 released · 2018-04-23

Package metadata

First published: 2019-04-09
Total releases: 3 / 7 yrs
License: GPL
Bundled data: 28 KB / 1 file
Download size: 48 KB
Installed size: not tracked yet
With dependencies: not tracked yet

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("SurrogateOutcome")

Format

Parast, L., & Wang, X. (2025). SurrogateOutcome: Estimation of the Proportion of Treatment Effect Explained by Surrogate Outcome Information (Version 1.2) [Computer software]. https://doi.org/10.32614/CRAN.package.SurrogateOutcome

This is what citation() produces when a package has no citation file of its own. If it prints something else, use that.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for SurrogateOutcome version 1.2 [Data set]. HJJB, LLC. Data release v2026-08-23. https://doi.org/10.5281/zenodo.21843040

From data release v2026-08-23, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →