R Observatory: Metrics for OptimalSurrogate version 1.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

OptimalSurrogate

1.0Package record

Model Free Approach to Quantifying Surrogacy

0packages depend

2.2Kdownloads / year

–test coverage

13/13flavors OK

Overview

About

Maintained by Layla ParastCRAN page ↗

Identifies an optimal transformation of a surrogate marker such that the proportion of treatment effect explained can be inferred based on the transformation of the surrogate and nonparametrically estimates two model-free quantities of this proportion. Details are described in Wang et al (2020) doi:10.1093/biomet/asz065.

Install

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

install.packages("OptimalSurrogate", 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-optimalsurrogate

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

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-OptimalSurrogate

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-OptimalSurrogate

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 51 s · r-devel-windows-x86_64

Status changes

OK13 OK2026-09-08
ERROR12 OK, 1 ERROR2026-09-07
OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 1.0

READMENoVignettesNoNEWSNoCitation fileNoWebsitenot declared in DESCRIPTION

Help pages: 4
Examples that run: 100%2 run in a plain check
Exported functions with examples: 100%
Documented parameters: 100%
Return-value docs: 100%
Help pages citing references: 0%

How these are measured

Downloads

2.2K

CRAN downloads in the past year

Rank #23,630 · ~6/day · ~181/mo

Releases R versions

Daily download trend is not available in this view yet.

21530 days

54990 days

2.2K1 year

Compare downloads with other packages →

Also on67 r2u2 autocran

How downloads are counted

Dependencies

Declared dependencies

0 external dependencies (excludes base and recommended)

Installing OptimalSurrogate adds no packages beyond those that come with R.

Depends (1)

R >= 3.0

Imports (3)

splinesMASSstats

LinkingTo (0)

none

Suggests (0)

none

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

Datasets

People & History

People (5)

Layla Parast

Author, Maintainer since 1.0 (2022)

Author

Author

Author

Author

Releases (1)

R
R 4.6.0 released · 2026-04-24
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
1.0Latest
record
2022-09-27 · current release
R
R 4.2.0 released · 2022-04-22

Package metadata

First published: 2022-09-27
Total releases: 1 / 4 yrs
License: GPL-3 OSI
Minimum R: ≥ 3.0
Bundled data: 9.4 KB / 2 files
Download size: 13 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("OptimalSurrogate")

Format

Parast, L., Cai, T., Tian, L., Wang, X., & Yang, M. (2022). OptimalSurrogate: Model Free Approach to Quantifying Surrogacy (Version 1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.OptimalSurrogate

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

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 OptimalSurrogate version 1.0 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, 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 →