Formatting

.github/workflows/render-rmarkdown.yaml → .github/workflows/render-preview.yaml

@@ -13,10 +13,10 @@ on:
   push:
     paths: ['**.Rmd', '**.*tex']
 
-name: render-rmarkdown
+name: render-preview
 
 jobs:
-  render-rmarkdown:
+  render-preview:
     runs-on: ubuntu-latest
     env:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,19 +1,21 @@
 # latex-math
 
+<!-- badges: start -->
+[![render-preview](https://github.com/slds-lmu/latex-math/actions/workflows/render-preview.yaml/badge.svg)](https://github.com/slds-lmu/latex-math/actions/workflows/render-preview.yaml)
+<!-- badges: end -->
+
 The notation and shortcuts used in latex-files of lectures, papers, ... of the Working Group Computational Statistics is defined and maintained in this repository. 
 Notation & shortcuts are split into multiple files depending on subject and can be integrated as needed. 
 
-+ basic-math: basic mathematical notation such as mathematical spaces, sums & products, linear algebra, basic probability and statistics
-+ basic-ml: basic machine learning notation such as notation for data (x, y), prediction functions, likelihood, loss functions, generalization error
-+ ml-bagging
-+ ml-boosting
-+ ml-mbo
-+ ml-nn: neural networks
-+ ml-svm: support vector machines
-+ ml-trees: decision trees
-+ ml-interpretable: IML / xAI
++ `basic-math`: basic mathematical notation such as mathematical spaces, sums & products, linear algebra, basic probability and statistics
++ `basic-ml`: basic machine learning notation such as notation for data (x, y), prediction functions, likelihood, loss functions, generalization error
++ `ml-nn`: neural networks
++ `ml-svm`: support vector machines
++ `ml-trees`: decision trees
++ `ml-interpretable`: IML / xAI
 
 ## Using the notation
+
 - Clone this repository into the main directory of your repo.
 - Add latex-math to the gitignore file. 
 - Add \input{../latex-math/\*}, for every file /\* you need to the preamble of your (TeX/Rmd) file but not into any common preamble file
@@ -24,11 +26,11 @@ Note that some of the macros defined here may use additional Latex packages -- a
 
 ```
 \usepackage{mathtools}
-\usepackage{bm} %basic-ml, ml-gp
-\usepackage{siunitx} %basic-ml
-\usepackage{dsfont} %basic-math
-\usepackage{xspace} %ml-mbo
-\usepackage{xifthen} %ml-interpretable
+\usepackage{bm}      % basic-ml, ml-gp
+\usepackage{siunitx} % basic-ml
+\usepackage{dsfont}  % basic-math
+\usepackage{xspace}  % ml-mbo
+\usepackage{xifthen} % ml-interpretable
 ```
 
 See `latex-math.pdf` for all currently defined commands & definitions. 

latex-math.Rmd

@@ -6,28 +6,28 @@ output:
   pdf_document:
     keep_tex: TRUE
 header-includes:
-   - \usepackage{mathtools}
-   - \usepackage{bm}
-   - \usepackage{siunitx}
-   - \usepackage{dsfont}
-   - \usepackage{xspace}
-   - \usepackage{longtable}
-   - \usepackage{xifthen}
-   - \input{basic-ml.tex}
-   - \input{basic-math.tex}
-   - \input{ml-ensembles.tex}
-   - \input{ml-eval.tex}
-   - \input{ml-mbo.tex}
-   - \input{ml-online.tex}
-   - \input{ml-multitarget.tex}
-   - \input{ml-feature-sel.tex}
-   - \input{ml-gp.tex}
-   - \input{ml-hpo.tex}
-   - \input{ml-interpretable.tex}
-   - \input{ml-nn.tex}
-   - \input{ml-survival.tex}
-   - \input{ml-svm.tex}
-   - \input{ml-trees.tex}
+  - \usepackage{mathtools}
+  - \usepackage{bm}
+  - \usepackage{siunitx}
+  - \usepackage{dsfont}
+  - \usepackage{xspace}
+  - \usepackage{longtable}
+  - \usepackage{xifthen}
+  - \input{basic-ml.tex}
+  - \input{basic-math.tex}
+  - \input{ml-ensembles.tex}
+  - \input{ml-eval.tex}
+  - \input{ml-mbo.tex}
+  - \input{ml-online.tex}
+  - \input{ml-multitarget.tex}
+  - \input{ml-feature-sel.tex}
+  - \input{ml-gp.tex}
+  - \input{ml-hpo.tex}
+  - \input{ml-interpretable.tex}
+  - \input{ml-nn.tex}
+  - \input{ml-survival.tex}
+  - \input{ml-svm.tex}
+  - \input{ml-trees.tex}
 editor_options:
   chunk_output_type: console
 ---