README.Rmd

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

```{r}
#| label: init
#| include: false

library(magrittr,
        include.only = c("%>%", "%<>%", "%T>%", "%!>%", "%$%"))

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

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

```{r}
#| label: pkg-desc
#| child: !expr pkgsnip::snip_path("pkg-desc.Rmd")
```

```{r}
#| label: pkg-doc
#| eval: !expr '!isTRUE(getOption("pal.build_readme.is_pkgdown"))'
#| results: asis
#| echo: false

pkgsnip::md_snip(id = "pkgdown_site") %>%
  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: pkg-instl-dev
#| child: !expr pkgsnip::snip_path("pkg-instl-dev-gitlab.Rmd")
```

```{r}
#| label: pkg-usage
#| eval: !expr isTRUE(getOption("pal.build_readme.is_pkgdown"))
#| results: asis
#| echo: false

pkgsnip::md_snip(id = "pkg_usage") %>%
  paste0("## Usage\n\n", .) |>
  pal::cat_lines()
```

## Development

### R Markdown format

```{r}
#| label: pkgpurl
#| child: !expr pkgsnip::snip_path("pkgpurl.Rmd")
```

### Coding style

```{r}
#| label: pkg-code-style
#| child: !expr pkgsnip::snip_path("pkg-code-style.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).