Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/avallecam/usethistest

What the Package Does (One Line, Title Case)
https://github.com/avallecam/usethistest

Last synced: 1 day ago
JSON representation

What the Package Does (One Line, Title Case)

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%"
)
```

# usethistest

[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/usethistest)](https://CRAN.R-project.org/package=usethistest)
[![R-CMD-check](https://github.com/avallecam/usethistest/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/avallecam/usethistest/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/avallecam/usethistest/branch/master/graph/badge.svg)](https://app.codecov.io/gh/avallecam/usethistest?branch=master)

The goal of usethistest is to ...

## Installation

You can install the development version of usethistest 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:

```{r example}
library(usethistest)
## basic example code
```

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 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.