knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

bat2bat

# bat2bat <img src="man/figures/logo.png" align="right" height="98" />
library("badger")
cat(
  ## badge_github_actions(),
  ## badge_codecov("helseprofil/bat2bat"),
  badge_lifecycle("experimental", "orange"),
  badge_github_version("helseprofil/bat2bat", "blue")
)

The goal of bat2bat is to ...

Installation

You can install the development version of bat2bat like so:

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

library(bat2bat)
## basic example code

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

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: https://github.com/r-lib/actions/tree/v1/examples.

You can also embed plots, for example:

plot(pressure)

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



folkehelseprofil/bat2bat documentation built on March 24, 2022, 11:20 p.m.