Skip to content

Commit

Permalink
vignette toc
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentarelbundock committed Dec 19, 2024
1 parent be06703 commit a4dd728
Show file tree
Hide file tree
Showing 6 changed files with 81 additions and 27 deletions.
5 changes: 2 additions & 3 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,13 @@ Makefile
^README\.Rmd$
^sandbox$
\.code-workspace$
^vignettes$
^.*\.Rproj$
^\.Rproj\.user$
man-roxygen
.*_files
^altdoc$
^_quarto$
README.qmd
vignettes/
vignettes
\.python-version
pyproject\.toml
requirements\.lock
Expand All @@ -36,3 +33,5 @@ requirements-dev\.lock
.python-version
pyproject.toml
uv.lock
^vignettes/\.quarto$
^vignettes/*_files$
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ vignettes/*html
src/*.so
src/*.o
_quarto/*
**/.quarto/
7 changes: 4 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@ Imports:
methods,
rlang,
Rcpp (>= 1.0.0)
Enhances:
knitr
LinkingTo: Rcpp, RcppEigen
Suggests:
AER,
Expand Down Expand Up @@ -185,7 +183,9 @@ Suggests:
yaml,
xgboost,
testthat (>= 3.0.0),
altdoc
altdoc,
knitr,
quarto
Collate:
'RcppExports.R'
'backtransform.R'
Expand Down Expand Up @@ -313,3 +313,4 @@ Collate:
'zzz.R'
Language: en-US
Config/testthat/edition: 3
VignetteBuilder: knitr, quarto
3 changes: 3 additions & 0 deletions vignettes/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.html
*.R
*_files
21 changes: 0 additions & 21 deletions vignettes/citation.qmd

This file was deleted.

71 changes: 71 additions & 0 deletions vignettes/model_to_meaning.Rmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: "Model to Meaning"
output: rmarkdown::html_vignette
vignette: >
%\VignetteIndexEntry{Model to Meaning}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```

The [marginaleffects.com](https://marginaleffects.com) website includes detailed documentation for both the `R` and `Python` versions of the `marginaleffects` package.

It also includes a complete free version of this forthcoming book

> *Model to Meaning: How to Interpret Statistical Results Using marginaleffects for R and Python.* Arel-Bundock, Vincent. CRC Chapman & Hall.
In addition to full book chapters, [marginaleffects.com](https://marginaleffects.com) includes a lot of bonus content. In total, there are over 40 detailed vignettes and tutorials, including:

1. [Home](https://marginaleffects.com/)
1. [Who is this website for?](https://marginaleffects.com/chapters/who.html)
1. [Quick start](https://marginaleffects.com/bonus/get_started.html)
1. Interpretation
- [Models and meaning](https://marginaleffects.com/chapters/challenge.html)
- [Tools and data](https://marginaleffects.com/chapters/tools.html)
- [Conceptual framework](https://marginaleffects.com/chapters/framework.html)
1. Quantities and Tests
- [Hypothesis and equivalence tests](https://marginaleffects.com/chapters/hypothesis.html)
- [Predictions](https://marginaleffects.com/chapters/predictions.html)
- [Counterfactual comparisons](https://marginaleffects.com/chapters/comparisons.html)
- [Slopes](https://marginaleffects.com/chapters/slopes.html)
1. Case Studies
- [Interactions, polynomials, and splines](https://marginaleffects.com/chapters/interactions.html)
- [Categorical and ordinal outcomes](https://marginaleffects.com/chapters/categorical.html)
- [Experiments](https://marginaleffects.com/chapters/experiments.html)
- [Mixed effects regression and post-stratification](https://marginaleffects.com/chapters/mrp.html)
- [Machine learning](https://marginaleffects.com/chapters/ml.html)
- [Uncertainty](https://marginaleffects.com/chapters/uncertainty.html)
1. Bonus Content
- [Help](https://marginaleffects.com/bonus/help.html)
- [FAQ](https://marginaleffects.com/bonus/faq.html)
- [Plots](https://marginaleffects.com/bonus/plot.html)
- [Alternative Software](https://marginaleffects.com/bonus/alternative_software.html)
- [Bayes](https://marginaleffects.com/bonus/brms.html)
- [Elasticity](https://marginaleffects.com/bonus/elasticity.html)
- [Extensions](https://marginaleffects.com/bonus/extensions.html)
- [GAM](https://marginaleffects.com/bonus/gam.html)
- [G-Computation](https://marginaleffects.com/bonus/gcomputation.html)
- [Heterogeneity](https://marginaleffects.com/bonus/heterogeneity.html)
- [Inverse Probability Weighting](https://marginaleffects.com/bonus/ipw.html)
- [Links](https://marginaleffects.com/bonus/links.html)
- [Logit](https://marginaleffects.com/bonus/logit.html)
- [Marginal Means](https://marginaleffects.com/bonus/marginalmeans.html)
- [Matching](https://marginaleffects.com/bonus/matching.html)
- [Meme gallery](https://marginaleffects.com/bonus/meme.html)
- [Multiple Comparisons](https://marginaleffects.com/bonus/multiple_comparisons.html)
- [NumPyro](https://marginaleffects.com/bonus/numpyro.html)
- [Performance](https://marginaleffects.com/bonus/performance.html)
- [Supported Models](https://marginaleffects.com/bonus/supported_models.html)
- [S Values](https://marginaleffects.com/bonus/svalues.html)
- [Tables](https://marginaleffects.com/bonus/tables.html)
1. Back Matter
- [Python](https://marginaleffects.com/chapters/python.html)
- [Bibliography](https://marginaleffects.com/chapters/bibliography.html)
1. [Citation and License](https://marginaleffects.com/bonus/citation.html)

0 comments on commit a4dd728

Please sign in to comment.