rmdl

A Causality-Informed Modeling Appraoch

https://github.com/shah-in-boots/rmdl

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.0%) to scientific vocabulary

Keywords

epidemiology modeling r r-package rstats statistics

Last synced: 10 months ago · JSON representation

Repository

A Causality-Informed Modeling Appraoch

Basic Info

Host: GitHub
Owner: shah-in-boots
License: other
Language: R
Default Branch: main
Homepage: https://shah-in-boots.github.io/rmdl/
Size: 10.2 MB

Statistics

Stars: 0
Watchers: 1
Forks: 0
Open Issues: 11
Releases: 1

Topics

epidemiology modeling r r-package rstats statistics

Created over 5 years ago · Last pushed almost 2 years ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# rmdl


[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/rmdl)](https://CRAN.R-project.org/package=rmdl)
[![](http://cranlogs.r-pkg.org/badges/grand-total/rmdl?color=blue)](https://cran.r-project.org/package=rmdl)
[![R-CMD-check](https://github.com/shah-in-boots/rmdl/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/shah-in-boots/rmdl/actions/workflows/R-CMD-check.yaml)
[![pkgdown](https://github.com/shah-in-boots/rmdl/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/shah-in-boots/rmdl/actions/workflows/pkgdown.yaml)
[![test-coverage](https://github.com/shah-in-boots/rmdl/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/shah-in-boots/rmdl/actions/workflows/test-coverage.yaml)
[![Codecov test coverage](https://codecov.io/gh/shah-in-boots/rmdl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/shah-in-boots/rmdl?branch=main)
[![Github commit frequency](https://img.shields.io/github/commit-activity/w/shah-in-boots/rmdl)](https://github.com/shah-in-boots/rmdl/graphs/commit-activity) 


## Installation

This package can be downloaded from CRAN or from [Github](https://github.com/shah-in-boots/rmdl) as below

```{r, eval = FALSE}
# CRAN installation
install.packages("rmdl")
# Or remote/developmental version
remotes::install_github("shah-in-boots/rmdl")
```

## Introduction

The package `{rmdl}` was intended as a way to handle causal- and epidemiology-based modeling by the following principles:

1. Role determination of variables
2. Generativity in formula creation
3. Multiple model management

## Usage

The package is simple to use. 
The `mtcars` dataset will serve as the example, and we will use linear regressions as the primary test.
This toy example shows that we will be building six models in parallel, with the key exposure being the __wt__ term, and the two outcomes being __mpg__ and __hp__.

```{r}
library(rmdl)

f <- fmls(mpg + hp ~ .x(wt) + disp + cyl + am, pattern = "parallel")
m <- fit(f, .fn = lm, data = mtcars, raw = FALSE)
mt <- model_table(mileage = m)
print(mt)
```

## Classes

There are several important extended classes that this package introduces, however they are primarily used for internal validation and for shortcuts to allow more effective communication.

- `fmls` are a *version* of the base `R` formula object, but contain additional information and have extra features
- `tm` are atomic elements used to describe individual variables, and departs from how terms are generally treated in the `{stats}` package
- `mdl` and `mdl_tbl` exist primarily as *tidy* versions of class regression modeling

## Advanced Usage

The [`{rmdl}`](https://cran.r-project.org/package=rmdl) package is intended to be flexible, extensible, and easy-to-use (albeit opinionated). 
Please see the vignettes for additional information.

Owner

Name: Anish S. Shah
Login: shah-in-boots
Kind: user
Location: Chicago, IL

Website: shah-in-boots.github.io
Twitter: shah_in_boots
Repositories: 1
Profile: https://github.com/shah-in-boots

physician interested in stress & arrhythmias, cardiac electrophysiology, epidemiology, and computational genetics

GitHub Events

Total

Last Year

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 34
Total pull requests: 35
Average time to close issues: 3 months
Average time to close pull requests: 4 minutes
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 0.68
Average comments per pull request: 0.0
Merged pull requests: 35
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 2
Average time to close issues: N/A
Average time to close pull requests: less than a minute
Issue authors: 0
Pull request authors: 1
Average comments per issue: 0
Average comments per pull request: 0.0
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

shah-in-boots (20)

Pull Request Authors

shah-in-boots (44)

Top Labels

Issue Labels

development (12) complex (6) documentation (5) bug (5) priority (3) question (3) help (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 527 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 1
Total maintainers: 1

cran.r-project.org: rmdl

Language to Manage Many Models

Homepage: https://github.com/shah-in-boots/rmdl
Documentation: http://cran.r-project.org/web/packages/rmdl/rmdl.pdf
License: MIT + file LICENSE
Latest release: 0.1.0
published about 2 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 527 Last month

Rankings

Dependent packages count: 27.8%

Dependent repos count: 35.7%

Average: 49.4%

Downloads: 84.9%

Maintainers (1)

ashah282@uic.edu