Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentarelbundock committed Mar 13, 2024
1 parent 71e5465 commit adc52db
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 25 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@


<p align="center">
<a href="https://modelsummary.com">
<img src="man/figures/modelsummary_gallery.gif" height = "250" class = "center">
Expand Down Expand Up @@ -51,10 +50,6 @@ statistics* and to summarize *statistical models* in `R`.
- `datasummary_df`: Turn dataframes into nice tables with titles,
notes, etc.

With these functions, you can create tables and plots like these:

<img src="https://user-images.githubusercontent.com/987057/103904985-060d0880-50cc-11eb-8be0-3922ef5108e0.png" align="center" width="100%">

## Why?

Here are a few benefits of `modelsummary` over some [alternative
Expand Down Expand Up @@ -99,7 +94,9 @@ intervals; add titles, footnotes, or source notes; insert stars or
custom characters to indicate levels of statistical significance; or add
rows with supplemental information about your models.

*Appearance*: Thanks to the [`gt`](https://gt.rstudio.com),
*Appearance*: Thanks to the
[`tinytable`](https://vincentarelbundock.github.io/tinytable/),
[`gt`](https://gt.rstudio.com),
[`kableExtra`](https://haozhu233.github.io/kableExtra/),
[`huxtable`](https://hughjonesd.github.io/huxtable/),
[`flextable`](https://davidgohel.github.io/flextable/), and
Expand Down Expand Up @@ -128,11 +125,11 @@ formats.](https://modelsummary.com/articles/modelsummary.html#rmarkdown-and-knit
#### Dangerous

`modelsummary` is dangerous! It allows users to do stupid stuff like
[replacing their intercepts by
squirrels.](https://modelsummary.com/articles/appearance.html#gt-1)
[inserting squirrels in all your
tables.](https://modelsummary.com/articles/appearance.html#gt-1)

<center>
<img src="https://user-images.githubusercontent.com/987057/82818916-7a60a780-9e6d-11ea-96ed-04fa92874a23.png" width="40%">
<img src="man/figures/squirrel.png" width="40%">
</center>

#### Reliable
Expand Down
9 changes: 3 additions & 6 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
- `datasummary_skim`: Quick overview ("skim") of a dataset.
- `datasummary_df`: Turn dataframes into nice tables with titles, notes, etc.

With these functions, you can create tables and plots like these:

<img src="https://user-images.githubusercontent.com/987057/103904985-060d0880-50cc-11eb-8be0-3922ef5108e0.png" align="center" width="100%">

## Why?

Expand Down Expand Up @@ -66,18 +63,18 @@ modelsummary(mod, output = "table.tex")

*Information*: The package offers many intuitive and powerful utilities to [customize the information](https://modelsummary.com/articles/modelsummary.html) reported in a summary table. You can rename, reorder, subset or omit parameter estimates; choose the set of goodness-of-fit statistics to include; display various “robust” standard errors or confidence intervals; add titles, footnotes, or source notes; insert stars or custom characters to indicate levels of statistical significance; or add rows with supplemental information about your models.

*Appearance*: Thanks to the [`gt`](https://gt.rstudio.com), [`kableExtra`](https://haozhu233.github.io/kableExtra/), [`huxtable`](https://hughjonesd.github.io/huxtable/), [`flextable`](https://davidgohel.github.io/flextable/), and [`DT`](https://rstudio.github.io/DT/) packages, the appearance of `modelsummary` tables is endlessly customizable. The [appearance customization page](https://modelsummary.com/articles/appearance.html) shows tables with colored cells, weird text, spanning column labels, row groups, titles, source notes, footnotes, significance stars, and more. This only scratches the surface of possibilities.
*Appearance*: Thanks to the [`tinytable`](https://vincentarelbundock.github.io/tinytable/), [`gt`](https://gt.rstudio.com), [`kableExtra`](https://haozhu233.github.io/kableExtra/), [`huxtable`](https://hughjonesd.github.io/huxtable/), [`flextable`](https://davidgohel.github.io/flextable/), and [`DT`](https://rstudio.github.io/DT/) packages, the appearance of `modelsummary` tables is endlessly customizable. The [appearance customization page](https://modelsummary.com/articles/appearance.html) shows tables with colored cells, weird text, spanning column labels, row groups, titles, source notes, footnotes, significance stars, and more. This only scratches the surface of possibilities.

*Supported models*: Thanks to the [`broom`](https://broom.tidymodels.org/) and [`parameters`](https://easystats.github.io/parameters/), `modelsummary` supports *hundreds* of statistical models out-of-the-box. Installing other packages can extend the capabilities further (e.g., [`broom.mixed`](https://CRAN.R-project.org/package=broom.mixed)). It is also very easy to [add or customize your own models.](https://modelsummary.com/articles/modelsummary.html#adding-new-models-1)

*Output formats*: `modelsummary` tables can be saved to HTML, LaTeX, Text/Markdown, Microsoft Word, Powerpoint, RTF, JPG, or PNG formats. They can also be inserted seamlessly in Rmarkdown documents to produce [automated documents and reports in PDF, HTML, RTF, or Microsoft Word formats.](https://modelsummary.com/articles/modelsummary.html#rmarkdown-and-knitr-1)

#### Dangerous

`modelsummary` is dangerous\! It allows users to do stupid stuff like [replacing their intercepts by squirrels.](https://modelsummary.com/articles/appearance.html#gt-1)
`modelsummary` is dangerous\! It allows users to do stupid stuff like [inserting squirrels in all your tables.](https://modelsummary.com/articles/appearance.html#gt-1)

<center>
<img src="https://user-images.githubusercontent.com/987057/82818916-7a60a780-9e6d-11ea-96ed-04fa92874a23.png" width="40%">
<img src="man/figures/squirrel.png" width="40%">
</center>

#### Reliable
Expand Down
20 changes: 20 additions & 0 deletions altdoc/custom.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
/*-- scss:defaults --*/
@import url(http://fonts.googleapis.com/css?family=Lato|Roboto|Open+Sans:400italic,700italic,400,700);
@import url(http://fonts.googleapis.com/css?family=Source+Code+Pro:400italic,700italic,400,700);
$font-family-sans-serif: 'Lato';

$body-color: #222 !default;
$link-color: #5e7ca1;
$code-color: #222;
$navbar-bg: #ececec;
$navbar-fg: #222;
$navbar-hl: #5e7ca1;
$sidebar-fg: #222;
$sidebar-hl: #5e7ca1;
$toc-color: #222;
$toc-hl: #5e7ca1;


.table {
font-size: .8em;
}
Binary file added altdoc/figures/gallery/gallery_08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added altdoc/figures/gallery/modelsummary_gallery.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 4 additions & 2 deletions altdoc/quarto_website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ format:
html:
toc: true
theme:
light: flatly
- flatly
- custom.scss
highlight-style: nord
code-copy: true
code-overflow: scroll
code-overflow: scroll
Binary file modified man/figures/modelsummary_gallery.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 1 addition & 8 deletions vignettes/modelsummary.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Now, we download data, fit some models, and summarize them in a table using the

```{r, message = FALSE}
library(modelsummary)
library(tinytable)
url <- 'https://vincentarelbundock.github.io/Rdatasets/csv/HistData/Guerry.csv'
dat <- read.csv(url)
Expand Down Expand Up @@ -681,13 +680,7 @@ Users who produce PDF documents using Rmarkdown or LaTeX can also align values o
modelsummary(models, align="lddddd")
```

For the table produced by this code to compile, users must include the following code in their LaTeX preamble:

```{latex, eval=FALSE}
\usepackage{booktabs}
\usepackage{siunitx}
\newcolumntype{d}{S[input-symbols = ()]}
```
See `?modelsummary` for a list of commands which need to appear in the LaTeX preamble to compile tables like this one.

# `notes`: footers

Expand Down

0 comments on commit adc52db

Please sign in to comment.