-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
67 lines (43 loc) · 2.87 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
---
output:
github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# rchitex
<!-- badges: start -->
[](https://www.tidyverse.org/lifecycle/#experimental)
[](https://travis-ci.org/bdempe18/rchitex)
[](https://ci.appveyor.com/project/bdempe18/rchitex)
<!-- badges: end -->
Rchitex provides allows users to generate elegantly formatted text tables for summary statistics and regression models while simultaneously writing the equivalent LaTeX code for individual tables or full appendices to a local file. Rchitex is likewise capable of producing Latex and HTML tables for markdown files. Rchitex is intended to bridge the gap between statistical exploration in R and article writing.
## Installation
You will be able to install the released version of rchitex from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("rchitex")
```
And the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("bdempe18/rchitex")
```
Until development exceeds the experimental phase, rchitex will only
be available on github.
## Overview
Rchitex's central goal is to ease the gap between statistical exploration and the writing process. Rchitex accomplishes this goal by providing tools that simplify the construction of appendixes and publication-ready tables. Dataframes and models are readily converted to LateX, html, and text output with a large number of available customizations. These table outputs can be stored as objects and deployed whenever so desired. Groupings of outputs (tables and Ggplot graphics) can then converted into into a LaTeX appendix without extraneous time spent formatting.
Rchitex also includes a hodgepodge of extra features, most notably a Robust Standard Error wrapper than simplifies standard error transformations.
## Supported models
Rchitex currently supports a growing number of model types. Currently, the list includes
- Linear and binominal regression (`lm` and `glm` in the stats package)
- Panel regression (contained in the `plm` package)
- Instrumental variables and Tobit regression (within the `AER` package)
Supported models are every-growing. Please feel free to request new models by making a pull request.
## Future development
The development branch of rchitex is currently working on providing statistical analysis of bibliographies. This help prevent authors from missing key pieces of literatures and help focus research.