README.md

BrokenAdaptiveRidge

Introduction

BrokenAdaptiveRidge is an R package for performing L_0-based regressions using Cyclops

Features

Examples

Technology

System Requirements

Requires R (version 3.2.0 or higher). Installation on Windows requires RTools (devtools >= 1.12 required for RTools34, otherwise RTools33 works fine).

Dependencies

• Cyclops

Getting Started

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

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

3. To perform a L_0-based Cyclops model fit, use the following commands in R:

library(BrokenAdaptiveRidge)
cyclopsData <- createCyclopsDataFrame(formula) ## TODO: Update
cyclopsFit <- fitCyclopsModel(cyclopsData)

Getting Involved

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

License

BrokenAdaptiveRidge is licensed under Apache License 2.0.

Development

BrokenAdaptiveRidge is being developed in R Studio.

Development status

Beta

Acknowledgements

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