From a4dd7283126bbec2989d024956ae93178597db0a Mon Sep 17 00:00:00 2001 From: Vincent Arel-Bundock Date: Wed, 18 Dec 2024 21:59:56 -0500 Subject: [PATCH] vignette toc --- .Rbuildignore | 5 +-- .gitignore | 1 + DESCRIPTION | 7 ++-- vignettes/.gitignore | 3 ++ vignettes/citation.qmd | 21 ---------- vignettes/model_to_meaning.Rmd | 71 ++++++++++++++++++++++++++++++++++ 6 files changed, 81 insertions(+), 27 deletions(-) create mode 100644 vignettes/.gitignore delete mode 100644 vignettes/citation.qmd create mode 100644 vignettes/model_to_meaning.Rmd diff --git a/.Rbuildignore b/.Rbuildignore index 2470828d4..41311e29d 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -17,7 +17,6 @@ Makefile ^README\.Rmd$ ^sandbox$ \.code-workspace$ -^vignettes$ ^.*\.Rproj$ ^\.Rproj\.user$ man-roxygen @@ -25,8 +24,6 @@ man-roxygen ^altdoc$ ^_quarto$ README.qmd -vignettes/ -vignettes \.python-version pyproject\.toml requirements\.lock @@ -36,3 +33,5 @@ requirements-dev\.lock .python-version pyproject.toml uv.lock +^vignettes/\.quarto$ +^vignettes/*_files$ diff --git a/.gitignore b/.gitignore index 4416b7ef0..a6861e0d1 100644 --- a/.gitignore +++ b/.gitignore @@ -27,3 +27,4 @@ vignettes/*html src/*.so src/*.o _quarto/* +**/.quarto/ diff --git a/DESCRIPTION b/DESCRIPTION index 38bbc73a2..51fb77cf4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -44,8 +44,6 @@ Imports: methods, rlang, Rcpp (>= 1.0.0) -Enhances: - knitr LinkingTo: Rcpp, RcppEigen Suggests: AER, @@ -185,7 +183,9 @@ Suggests: yaml, xgboost, testthat (>= 3.0.0), - altdoc + altdoc, + knitr, + quarto Collate: 'RcppExports.R' 'backtransform.R' @@ -313,3 +313,4 @@ Collate: 'zzz.R' Language: en-US Config/testthat/edition: 3 +VignetteBuilder: knitr, quarto diff --git a/vignettes/.gitignore b/vignettes/.gitignore new file mode 100644 index 000000000..ba7abf328 --- /dev/null +++ b/vignettes/.gitignore @@ -0,0 +1,3 @@ +*.html +*.R +*_files diff --git a/vignettes/citation.qmd b/vignettes/citation.qmd deleted file mode 100644 index 225cf55b3..000000000 --- a/vignettes/citation.qmd +++ /dev/null @@ -1,21 +0,0 @@ -# Citation and License {.unnumbered} - -To cite `marginaleffects` in publications, please use: - -> Arel-Bundock V, Greifer N, Heiss A (Forthcoming). "How to Interpret Statistical Models Using marginaleffects in R and Python." _Journal of Statistical Software_. - -```latex -@Article{, - title = {How to Interpret Statistical Models Using {marginaleffects} in {R} and {Python}}, - author = {Vincent Arel-Bundock and Noah Greifer and Andrew Heiss}, - year = {Forthcoming}, - journal = {Journal of Statistical Software}, -} -``` - -The `marginaleffects` software code is licenced under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) - -The contents of this website and the *Model to Meaning* book are copyrighted and may not be reproduced without permission. - -© 2024 Vincent Arel-Bundock. All Rights Reserved. - diff --git a/vignettes/model_to_meaning.Rmd b/vignettes/model_to_meaning.Rmd new file mode 100644 index 000000000..38c2f6a99 --- /dev/null +++ b/vignettes/model_to_meaning.Rmd @@ -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) +