README.Rmd

---
output: pal::gitlab_document
---

```{r}
#| label: setup
#| include: false
library(magrittr,
        include.only = c("%>%", "%<>%", "%T>%", "%!>%", "%$%"))

knitr::opts_knit$set(root.dir = getwd())
```

# `r pal::desc_value("Package")`

`r paste0('[![CRAN Status](https://r-pkg.org/badges/version/', pal::desc_value(key = "Package"), ')](https://cran.r-project.org/package=', pal::desc_value(key = "Package"), '){.pkgdown-release}')`

`r pal::desc_value("Description")`

```{r}
#| label: documentation
#| eval: !expr '!isTRUE(getOption("pal.build_readme.is_pkgdown"))'
#| results: asis
#| echo: false
pkgsnip::md_snip(id = "pkgdown_notice") %>%
  paste0("## Documentation\n\n",
         "[![Netlify Status](https://api.netlify.com/api/v1/badges/ac353053-cecb-49fa-9236-bfcd664e036c/deploy-status)]",
         "(https://app.netlify.com/sites/rstd-rpkg-dev/deploys)\n\n",
         .) |>
  pal::cat_lines()
```

## Installation

```{r}
#| label: install-snippet-dev
#| child: !expr pkgsnip::snip_path("installation-notice_dev-version_gitlab.Rmd")
```

```{r}
#| label: usage
#| eval: !expr isTRUE(getOption("pal.build_readme.is_pkgdown"))
#| results: asis
#| echo: false
pkgsnip::md_snip(id = "usage_notice") %>%
  paste0("## Usage\n\n", .) |>
  pal::cat_lines()
```

## Development

### R Markdown format

```{r}
#| label: rmd-format
#| child: !expr pkgsnip::snip_path("rmd-package-notice.Rmd")
```

### Coding style

```{r}
#| label: coding-style
#| child: !expr pkgsnip::snip_path("coding-style-notice.Rmd")
```

## See also

-   The official [**rstudioapi**](https://rstudio.github.io/rstudioapi/) R package containing a handful of useful wrapper functions to access the [RStudio
    API](https://rstudio.github.io/rstudio-extensions/rstudioapi.html).