https://github.com/pharmaverse/admiraldev
Development Tools for the admiral family
https://github.com/pharmaverse/admiraldev
Last synced: 4 months ago
JSON representation
Development Tools for the admiral family
- Host: GitHub
- URL: https://github.com/pharmaverse/admiraldev
- Owner: pharmaverse
- License: apache-2.0
- Created: 2022-07-14T14:52:13.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T21:06:28.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:55:50.140Z (about 1 year ago)
- Language: R
- Homepage: https://pharmaverse.github.io/admiraldev/dev
- Size: 18.6 MB
- Stars: 14
- Watchers: 5
- Forks: 6
- Open Issues: 23
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- jimsghstars - pharmaverse/admiraldev - Development Tools for the admiral family (R)
README
---
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"
```
# admiraldev 
Utility Functions and Development Tools for the Admiral Package Family
[](https://CRAN.R-project.org/package=admiraldev)
[](https://github.com/pharmaverse/admiraldev/actions/workflows/common.yml)
## 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).