Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/OHDSI/OhdsiRTools

An R package of support tools that didn’t fit other categories, including tools for maintaining R libraries.
https://github.com/OHDSI/OhdsiRTools

Last synced: 9 days ago
JSON representation

An R package of support tools that didn’t fit other categories, including tools for maintaining R libraries.

Awesome Lists containing this project

README

        

OhdsiRTools
===========

[![Build Status](https://github.com/OHDSI/OhdsiRTools/workflows/R-CMD-check/badge.svg)](https://github.com/OHDSI/OhdsiRTools/actions?query=workflow%3AR-CMD-check)
[![codecov.io](https://codecov.io/github/OHDSI/OhdsiRTools/coverage.svg?branch=main)](https://codecov.io/github/OHDSI/OhdsiRTools?branch=main)

Introduction
============
An R package with tools to help write and maintain other OHDSI R packages. Other OHDSI R packages should not depend on or import OhdsiRTools.

Features
========
- Auto checking of R code.
- Generate renv lock files with correct references to OHDSI repos.

Examples
========

```r
# Create renv lock file
OhdsiRTools::createRenvLockFile(rootPackage = "MyStudyPackage",
includeRootPackage = TRUE)

# Identify problems in R code in a package:
checkUsagePackage("OhdsiRTools")
```

Technology
============
OhdsiRTools is an R package.

System Requirements
============
Requires R.

Installation
=============
1. In R, use the following commands to download and install OhdsiRTools:

```r
install.packages("remotes")
remotes::install_github("ohdsi/OhdsiRTools")
```

User Documentation
==================
Documentation can be found on the [package website](https://ohdsi.github.io/OhdsiRTools/).

PDF versions of the documentation are also available:
* Package manual: [OhdsiRTools.pdf](https://raw.githubusercontent.com/OHDSI/OhdsiRTools/main/extras/OhdsiRTools.pdf)

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

Contributing
============
Read [here](https://ohdsi.github.io/MethodsLibrary/contribute.html) how you can contribute to this package.

License
=======
OhdsiRTools is licensed under Apache License 2.0

Development
===========
OhdsiRTools is being developed in R Studio.

### Development status

Ready for use

# Acknowledgements
- This project is supported in part through the National Science Foundation grant IIS 1251151.