README.Rmd

---
title: "admiraldev"
output: md_document
date: '2022-06-27'
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
link <- function(text, url) {
  return(
    paste0(
      "[", text, "]",
      "(", url, ")"
    )
  )
}
dyn.link <- function(text, base_url, relative_url = "") {
  branch <- Sys.getenv("BRANCH_NAME", "main")
  return(
    link(
      text,
      paste(base_url, branch, relative_url, sep = "/")
    )
  )
}

# Other variables
admiral_homepage <- "https://pharmaverse.github.io/admiral"
```

<!-- Please do not edit the README.md file as it is auto-generated. Only edit the README.Rmd file -->

# admiraldev <img src="man/figures/logo.png" align="right" alt="" width="120" />

Utility Functions and Development Tools for the Admiral Package Family


<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/admiraldev)](https://CRAN.R-project.org/package=admiraldev)
[![Test Coverage](https://raw.githubusercontent.com/pharmaverse/admiraldev/badges/main/test-coverage.svg)](https://github.com/pharmaverse/admiraldev/actions/workflows/common.yml)

<!-- badges: end -->


## Purpose

Functions, tools and documentation for developing core `{admiral}` and extension package functions. Most functions in `{admiraldev}` are around testing inputs going into  functions. There are also additional quality of life functions/Addins to assist developers of `{admiral}` or `{admiral}` extension packages, functions to help with rendering documentation, Developer Guides on developing function and using GitHub, GitHub Actions.  

**NOTE:** This package is not intended for standalone use but rather as a central dependency for `{admiral}` and its extension packages 

## Installation

The package is available from CRAN and can be installed by running `install.packages("admiraldev")`.

To install the latest development version of the package directly from GitHub use the following code:

```{r, eval = FALSE}
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

remotes::install_github("pharmaverse/admiraldev")
```

## Release Schedule

`{admiraldev}` is to be released to CRAN at the same time as an official release of `{admiral}`.  You can find the release schedule for `{admiral}` packages [here](https://pharmaverse.github.io/admiral/#release-schedule).