https://github.com/bisaloo/testreadme

https://github.com/bisaloo/testreadme

Last synced: 30 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bisaloo/testreadme
• Owner: Bisaloo
• Created: 2022-12-08T09:13:22.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-08T09:26:59.000Z (about 2 years ago)
• Last Synced: 2024-10-24T16:18:23.753Z (3 months ago)
• Size: 19.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# testreadme

The goal of testreadme is to ...

## Installation

You can install the development version of testreadme like so:

``` r

# FILL THIS IN! HOW CAN PEOPLE INSTALL YOUR DEV PACKAGE?

```

## Example

This is a basic example which shows you how to solve a common problem:

What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:

```{r cars}

summary(cars)

```

You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this. You could also use GitHub Actions to re-render `README.Rmd` every time you push. An example workflow can be found here: .

You can also embed plots, for example:

```{r pressure, echo = FALSE}

plot(pressure)

```

In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.