https://github.com/gaborcsardi/covrlabs

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

Last synced: 13 days ago
JSON representation

What the Package Does (One Line, Title Case)

• Host: GitHub
• URL: https://github.com/gaborcsardi/covrlabs
• Owner: gaborcsardi
• License: gpl-3.0
• Created: 2023-12-19T09:25:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-22T15:08:39.000Z (12 months ago)
• Last Synced: 2024-11-05T03:42:13.382Z (2 months ago)
• Language: C
• Homepage: http://gaborcsardi.org/covrlabs/
• Size: 4.08 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: .github/CODE_OF_CONDUCT.md
  • Support: .github/SUPPORT.md

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

)

```

# covrlabs

[![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/covrlabs)](https://CRAN.R-project.org/package=covrlabs)

[![R-CMD-check](https://github.com/gaborcsardi/covrlabs/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/gaborcsardi/covrlabs/actions/workflows/R-CMD-check.yaml)

[![Codecov test coverage](https://codecov.io/gh/gaborcsardi/covrlabs/branch/main/graph/badge.svg)](https://app.codecov.io/gh/gaborcsardi/covrlabs?branch=main)

The goal of covrlabs is to ...

## Installation

You can install the development version of covrlabs 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(covrlabs)

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