Skip to content

Commit

Permalink
change to using knitr for readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Nov 3, 2024
1 parent dae7f50 commit 0bb8788
Show file tree
Hide file tree
Showing 3 changed files with 698 additions and 646 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ check: build
@rm -rf ${PACKAGE}.Rcheck

readme:
${RSCRIPT} -e "rmarkdown::render('README.Rmd')"
${RSCRIPT} -e "knitr::knit('README.Rmd')"

check_windows:
${RSCRIPT} -e "devtools::check_win_devel(); devtools::check_win_release()"
42 changes: 1 addition & 41 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
output:
md_document
---

cowsay
======

Expand Down Expand Up @@ -199,25 +194,6 @@ say(
<img src="./man/figures/trilobite.png" alt="trilobite" height="250px">
</p>


<!-- Multiple colors are also possible (uses the [`multicolor`](https://github.com/aedobbyn/multicolor) package):
```{r eval=FALSE}
say(
what = "I'm a rare Irish buffalo",
by = "buffalo",
what_color = c("salmon2", "darkcyan", "salmon2", "darkcyan"),
by_color = c("green", "white", "orange")
)
```
<p align="left">
<img src="./man/figures/irish_buffalo.jpg" alt="irish_buffalo" height="350px">
</p>
-->

### Vary type of output, default calls message()

```{r}
Expand All @@ -239,24 +215,8 @@ say("hell no!", type = "string")

From the catfacts API at <https://catfact.ninja>

```{r eval=FALSE}
```{r}
say("catfact", "cat")
#> --------------
#> When a domestic cat goes after mice, about 1 pounce in 3 results in a catch.
#> --------------
#> \
#> \
#> \
#> |\___/|
#> ==) ^Y^ (==
#> \ ^ /
#> )=*=(
#> / \
#> | |
#> /| | | |\
#> \| | |_|/\
#> jgs //_// ___/
#> \_)
```

### Long cat
Expand Down
Loading

0 comments on commit 0bb8788

Please sign in to comment.