Cyclops

CRAN_Status_Badge CRAN_Status_Badge

Introduction

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

Features

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.

Dependencies

Getting Started

  1. On Windows, make sure RTools is installed.
  2. In R, use the following commands to download and install Cyclops:

r install.packages("devtools") library(devtools) install_github("ohdsi/Cyclops")

  1. To perform a Cyclops model fit, use the following commands in R:

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

Getting Involved

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.

Development status

Build Status codecov.io

Beta

Acknowledgements