Add cheat sheet

imbs-hl · Aug 21, 2024 · 4bddf30 · 4bddf30
1 parent 760f451
commit 4bddf30
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -46,9 +46,7 @@ knitr::include_graphics("README_files/figure-gfm/fuseMLR_4_blue_bgr.png")
 
 The general architecture of `fuseMLR` includes the storage classes `Training`, `Layer`, and `MetaLayer`. `Layer` and `MetaLayer` are stored within a `Training` instance, while `Data`, `Learner`, and `Varselect` (for variable selection) are stored within a `Layer` instance. These components can be used to automatically build and store the `Model` or `MetaModel`.
 
-```{r cheatsheet, echo=FALSE, out.width="70%", out.height="100%"}
-knitr::include_graphics("README_files/figure-gfm/fusemlrcheatsheet.png")
-```
+Refer to our [cheat sheet](https://github.com/imbs-hl/fuseMLR/blob/master/README_files/figure-gfm/fusemlrcheatsheet.pdf) for a quick overview of classes and functionalities.
 
 ### Usage example
 

diff --git a/README.md b/README.md
@@ -63,7 +63,9 @@ within a `Training` instance, while `Data`, `Learner`, and `Varselect`
 components can be used to automatically build and store the `Model` or
 `MetaModel`.
 
-<img src="README_files/figure-gfm/fusemlrcheatsheet.png" width="70%" height="100%" />
+Refer to our [cheat
+sheet](https://github.com/imbs-hl/fuseMLR/blob/master/README_files/figure-gfm/fusemlrcheatsheet.pdf)
+for a quick overview of classes and functionalities.
 
 ### Usage example