Skip to content

Commit

Permalink
[actions skip] Add/Update README.md for pre-release
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 30, 2022
1 parent c66b37a commit 6d5a748
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
ADaM in R Asset Library Development Utilities

<!-- badges: start -->

<!-- badges: end -->

## Purpose
Expand All @@ -13,26 +14,29 @@ Tools for developing functions and maintaining a healthy code base
within the family of admiral R packages. `{admiraldev}` is intended to
be used when developing `{admiral}` or `{admiral}` extension packages.

**NOTE:** Use of this package as a standalone package is currently not
recommended.
__NOTE:__ This package is not intended for standalone use but rather as
a central dependency for all developer utilities of `{admiral}` and its
extension packages

## Installation

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

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

if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
```
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
remotes::install_github("pharmaverse/admiraldev", ref = "devel")
remotes::install_github("pharmaverse/admiraldev", ref = "devel")
```

## Release Schedule

`{admiraldev}` is to be official released to CRAN one week before the
release of `{admiral}`. You can find the release schedule for
`{admiraldev}` is to be officially released to CRAN one week before an
official release of `{admiral}`. You can find the release schedule for
`{admiral}` packages
[here](https://github.com/pharmaverse/admiral/tree/devel#release-schedule).
[here](https://pharmaverse.github.io/admiral/#release-schedule).

0 comments on commit 6d5a748

Please sign in to comment.