Learn R Programming

Cyclops

Cyclops is part of the HADES.

Introduction

Cyclops (Cyclic coordinate descent for logistic, Poisson and survival analysis) is an R package for performing large scale regularized regressions.

Features

  • Regression of very large problems: up to millions of observations, millions of variables
  • Supports (conditional) logistic regression, (conditional) Poisson regression, as well as (conditional) Cox regression
  • Uses a sparse representation of the independent variables when appropriate
  • Supports using no prior, a normal prior or a Laplace prior
  • Supports automatic selection of hyperparameter through cross-validation
  • Efficient estimation of confidence intervals for a single variable using a profile-likelihood for that variable

Examples

  library(Cyclops)
  cyclopsData <- createCyclopsDataFrame(formula)
  cyclopsFit <- fitCyclopsModel(cyclopsData)

Technology

Cyclops in an R package, with most functionality implemented in C++. Cyclops uses cyclic coordinate descent to optimize the likelihood function, which makes use of the sparse nature of the data.

System Requirements

Requires R (version 3.1.0 or higher). Compilation on Windows requires RTools >= 3.4.

Installation

In R, to install the latest stable version, install from CRAN:

install.packages("Cyclops")

To install the latest development version, install from GitHub. Note that this will require RTools to be installed.

install.packages("devtools")
devtools::install_github("OHDSI/Cyclops")

User Documentation

Documentation can be found on the package website.

PDF versions of the documentation are also available:

Support

  • Developer questions/comments/feedback: OHDSI Forum
  • We use the GitHub issue tracker for all bugs/issues/enhancements

Contributing

Read here how you can contribute to this package.

License

Cyclops is licensed under Apache License 2.0. Cyclops contains the TinyThread libray.

The TinyThread library is licensed under the zlib/libpng license as described here.

Development

Cyclops is being developed in R Studio.

Acknowledgements

  • This project is supported in part through the National Science Foundation grants IIS 1251151 and DMS 1264153.

Copy Link

Version

Install

install.packages('Cyclops')

Monthly Downloads

1,173

Version

3.5.1

License

Apache License 2.0

Issues

20

Pull Requests

2

Stars

39

Forks

33

Maintainer

Marc A Suchard

Last Published

April 11th, 2025

Functions in Cyclops (3.5.1)

coverage

Coverage
createParameterizedPrior

Create a Cyclops parameterized prior object
createNonSeparablePrior

Create a Cyclops prior object that returns the MLE of non-separable coefficients
createCyclopsData

Create a Cyclops data object
finalizeSqlCyclopsData

finalizeSqlCyclopsData
getCrossValidationInfo

Get cross-validation information from a Cyclops model fit
getCovariateTypes

Get covariate types
createWeightBasedSearchControl

Create a Cyclops control object that supports in- / out-of-sample hyperparameter search using weights
getHyperParameter

Get hyperparameter
cyclops

Cyclops: Cyclic coordinate descent for logistic, Poisson and survival analysis
getNumberOfCovariates

Get total number of covariates
createControl

Create a Cyclops control object
createAutoGridCrossValidationControl

Create a Cyclops control object that supports multiple hyperparameters
getNumberOfRows

Get total number of rows
getNumberOfStrata

Get number of strata
getSEs

Extract standard errors
getFloatingPointSize

Get floating point size
getFineGrayWeights

Creates a Surv object that forces in competing risks and the IPCW needed for Fine-Gray estimation.
print.cyclopsFit

Print a Cyclops model fit object
print.cyclopsData

Print a Cyclops data object
mse

Mean squared error
oxford

Oxford self-controlled case series data
fitCyclopsSimulation

Fit simulated data
fitCyclopsModel

Fit a Cyclops model
getNumberOfTypes

Get total number of outcome types
setOpenCLDevice

Set GPU device
meanLinearPredictor

Calculates xbar*beta
logLik.cyclopsFit

Extract log-likelihood
runBootstrap

Run Bootstrap for Cyclops model parameter
readCyclopsData

Read Cyclops data from file
printMatrixMarket

Print Cyclops data matrix to file
getCyclopsProfileLogLikelihood

Profile likelihood for Cyclops model parameters
summary.cyclopsData

Cyclops data object summary
getCyclopsPredictiveLogLikelihood

Compute predictive log-likelihood from a Cyclops model fit
isInitialized

Check if a Cyclops data object is initialized
plotCyclopsSimulationFit

Plot Cyclops simulation model fit
survfit.cyclopsFit

Calculate baseline hazard function
getCovariateIds

Get covariate identifiers
splitTime

Split the analysis time into several intervals for time-varying coefficients.
listGPUDevices

List available GPU devices
simulateCyclopsData

Simulation Cyclops dataset
getUnivariableSeparability

Get univariable linear separability
getUnivariableCorrelation

Get univariable correlation
reduce

Apply simple data reductions
testProportionality

Test hazard ratio proportionality assumption
residuals.cyclopsFit

Model residuals
vcov.cyclopsFit

Calculate variance-covariance matrix for a fitted Cyclops model object
predict.cyclopsFit

Model predictions
aconfint

Asymptotic confidence intervals for a fitted Cyclops model object
convertToGlmnetLambda

Convert to glmnet regularization parameter
confint.cyclopsFit

Confidence intervals for Cyclops model parameters
convertToTimeVaryingCoef

Convert short sparse covariate table to long sparse covariate table for time-varying coefficients.
convertToCyclopsData

Convert data from two data frames or ffdf objects into a CyclopsData object
coef.cyclopsFit

Extract model coefficients
Multitype

Create a multitype outcome object
createPrior

Create a Cyclops prior object
convertToCyclopsVariance

Convert to Cyclops Prior Variance
appendSqlCyclopsData

appendSqlCyclopsData