---

output: github_document

---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

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

  out.width = "100%"

)

```

# PLCOm2012

<!-- badges: start -->

<!-- badges: end -->

The goal of PLCOm2012 is to ...

## Installation

You can install the released version of PLCOm2012 from [CRAN](https://CRAN.R-project.org) with:

``` r

install.packages("PLCOm2012")

```

And the development version from [GitHub](https://github.com/) with:

``` r

# install.packages("devtools")

devtools::install_github("resplab/PLCOm2012")

```

## Example

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

```{r example}

library(PLCOm2012)

## 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 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/master/examples>.

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.