diff --git a/README.Rmd b/README.Rmd index a4fc5159..c475398d 100644 --- a/README.Rmd +++ b/README.Rmd @@ -25,23 +25,23 @@ dyn.link <- function(text, base_url, relative_url = "") { } # Other variables -admiral_homepage <- "https://pharmaverse.github.io/admiraldev" +admiral_homepage <- "https://pharmaverse.github.io/admiral" ``` -# admiraldev - ADaM in R Asset Library Development Utilities +# admiraldev + +ADaM in R Asset Library Development Utilities - -## To Do Update Badges ## Purpose -Tools for developing functions and maintaining a healthy codebase within the family of admiral R packages. +Tools for developing functions and maintaining a healthy codebase within the family of admiral R packages. `{admiraldev}` is intended to be used when developing `{admiral}` or `{admiral}` extension packages. Use of this package as a standalone package is not recommended. ## Installation @@ -52,53 +52,15 @@ if (!requireNamespace("remotes", quietly = TRUE)) { install.packages("remotes") } -remotes::install_github("pharmaverse/admiral.test", ref = "devel") # This is a required dependency of {admiral} -remotes::install_github("pharmaverse/admiral", ref = "devel") remotes::install_github("pharmaverse/admiraldev", ref = "devel") -``` - -## Structure of package +remotes::install_github("pharmaverse/admiral.test", ref = "devel") +remotes::install_github("pharmaverse/admiral", ref = "devel") -```{r tree, echo=FALSE} -library(fs) -tree <- dir_tree("R", recurse = 2) ``` -## Keyword/Family - -| Keyword | Description | -|-----------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------| -| `assertion` | Asserts a certain type and gives warning, error to user | -| `warning` | Provides custom warnings to user -| `what` | A function that ... -| `is` | A function that ... -| `get` | A function that ... - - ## Release Schedule -Releases are done at the end of every of quarter on the last Monday. Pull Requests will be frozen the week before a release. -The `admiral` family has several downstream and upstream dependencies and so this release shall be done in three -Phases. - -* Phase 1 is for `admiraldev` and `admiral.test`, which feed into all `admiral` packages -* Phase 2 is only for core `admiral` -* Phase 3 is extension packages, e.g. `admiralonco` - -| Release Schedule | Phase 1- Date and Packages | Phase 2- Date and Packages | Phase 3- Date and Packages | -|----------------------------|------------------------------|---------------------------- |------------------------------| -| Q3-2022 | August 29th | September 5th | September 12th | -| | `admiraldev` | `admiral` | `admiralonco` | -| | `admiral.test` | | `admiralroche` | -| Q4-2022 | November 28th | December 5th | December 12th | -| | `admiraldev` | `admiral` | `admiralonco` | -| | `admiral.test` | | `admiralroche` | -| Q1-2023 | February 27th | March 6th | March 13th | -| | `admiraldev` | `admiral` | `admiralonco` | -| | `admiral.test` | | `admiralroche` | -| Q2-2023 | May 29th | June 5th | June 12th | -| | `admiraldev` | `admiral` | `admiralonco` | -| | `admiral.test` | | `admiralroche` | +`{admiraldev}` is to be release one week before the release of `{admiral}`. You can find the release schedule for `{admiral}` packages here(TBL) diff --git a/README.md b/README.md index 35b15420..dea11f59 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ -# admiraldev - ADaM in R Asset Library Development Utilities +# admiraldev - +ADaM in R Asset Library Development Utilities - -## To Do Update Badges - ## Purpose Tools for developing functions and maintaining a healthy codebase within -the family of admiral R packages. +the family of admiral R packages. `{admiraldev}` is intended to be used +when developing `{admiral}` or `{admiral}` extension packages. Use of +this package as a standalone package is not recommended. ## Installation @@ -24,165 +23,12 @@ GitHub use the following code: install.packages("remotes") } - remotes::install_github("pharmaverse/admiral.test", ref = "devel") # This is a required dependency of {admiral} - remotes::install_github("pharmaverse/admiral", ref = "devel") remotes::install_github("pharmaverse/admiraldev", ref = "devel") - -## Structure of package - - ## R - ## ├── addin_format_testthat.R - ## ├── admiraldev-package.R - ## ├── assertions.R - ## ├── compat_friendly_type.R - ## ├── dataset_vignette.R - ## ├── dev_utilities.R - ## ├── expect_dfs_equal.R - ## ├── get.R - ## ├── global.R - ## ├── is.R - ## ├── quo.R - ## ├── quote.R - ## ├── reexports.R - ## ├── warnings.R - ## └── what.R - -## Keyword/Family - - ---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
KeywordDescription
assertionAsserts a certain type and gives warning, error to user
warningProvides custom warnings to user
whatA function that …
isA function that …
getA function that …
+ remotes::install_github("pharmaverse/admiral.test", ref = "devel") + remotes::install_github("pharmaverse/admiral", ref = "devel") ## Release Schedule -Releases are done at the end of every of quarter on the last Monday. -Pull Requests will be frozen the week before a release. The `admiral` -family has several downstream and upstream dependencies and so this -release shall be done in three Phases. - -- Phase 1 is for `admiraldev` and `admiral.test`, which feed into all - `admiral` packages -- Phase 2 is only for core `admiral` -- Phase 3 is extension packages, e.g. `admiralonco` - - ------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Release SchedulePhase 1- Date and PackagesPhase 2- Date and PackagesPhase 3- Date and Packages
Q3-2022August 29thSeptember 5thSeptember 12th
admiraldevadmiraladmiralonco
admiral.testadmiralroche
Q4-2022November 28thDecember 5thDecember 12th
admiraldevadmiraladmiralonco
admiral.testadmiralroche
Q1-2023February 27thMarch 6thMarch 13th
admiraldevadmiraladmiralonco
admiral.testadmiralroche
Q2-2023May 29thJune 5thJune 12th
admiraldevadmiraladmiralonco
admiral.testadmiralroche
+`{admiraldev}` is to be release one week before the release of +`{admiral}`. You can find the release schedule for `{admiral}` packages +here(TBL) diff --git a/man/figures/admiraldev.png b/man/figures/admiraldev.png deleted file mode 100644 index 10100328..00000000 Binary files a/man/figures/admiraldev.png and /dev/null differ diff --git a/man/figures/logo.png b/man/figures/logo.png index 6e0055f6..10100328 100644 Binary files a/man/figures/logo.png and b/man/figures/logo.png differ diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png index a4c62fe0..7bb966d6 100644 Binary files a/pkgdown/favicon/apple-touch-icon-120x120.png and b/pkgdown/favicon/apple-touch-icon-120x120.png differ diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png index 0c239bc7..0fbea129 100644 Binary files a/pkgdown/favicon/apple-touch-icon-152x152.png and b/pkgdown/favicon/apple-touch-icon-152x152.png differ diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png index 7b4d5250..9c4f76ee 100644 Binary files a/pkgdown/favicon/apple-touch-icon-180x180.png and b/pkgdown/favicon/apple-touch-icon-180x180.png differ diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png index 95fe6025..26fde487 100644 Binary files a/pkgdown/favicon/apple-touch-icon-60x60.png and b/pkgdown/favicon/apple-touch-icon-60x60.png differ diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png index b26be219..121b62aa 100644 Binary files a/pkgdown/favicon/apple-touch-icon-76x76.png and b/pkgdown/favicon/apple-touch-icon-76x76.png differ diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png index 33b86b2f..68e67e0e 100644 Binary files a/pkgdown/favicon/apple-touch-icon.png and b/pkgdown/favicon/apple-touch-icon.png differ diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png index 20cc421c..cdf907e6 100644 Binary files a/pkgdown/favicon/favicon-16x16.png and b/pkgdown/favicon/favicon-16x16.png differ diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png index 8cefba3a..77c51a2f 100644 Binary files a/pkgdown/favicon/favicon-32x32.png and b/pkgdown/favicon/favicon-32x32.png differ diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico index 47d4a4bb..f7f85254 100644 Binary files a/pkgdown/favicon/favicon.ico and b/pkgdown/favicon/favicon.ico differ diff --git a/vignettes/admiraldev.Rmd b/vignettes/admiraldev.Rmd index 9c16bf2c..b46b0aad 100644 --- a/vignettes/admiraldev.Rmd +++ b/vignettes/admiraldev.Rmd @@ -4,7 +4,7 @@ output: rmarkdown::html_vignette vignette: > - %\VignetteIndexEntry{Contribution to {admiraldev}} + %\VignetteIndexEntry{Contribution to {admiral} and {admiraldev}} %\VignetteEngine{knitr::rmarkdown} --- diff --git a/vignettes/programming_strategy.Rmd b/vignettes/programming_strategy.Rmd index f20d908c..a65b48e1 100644 --- a/vignettes/programming_strategy.Rmd +++ b/vignettes/programming_strategy.Rmd @@ -407,6 +407,12 @@ add an issue in GitHub for discussion. | `high_order_function` | Higher Order Functions | | `move_adm_dev` | Functions moved to `admiraldev` package [Link TBA] | | `internal` | Internal functions only available to admiral developers | +| | | +| `assertion`* | Asserts a certain type and gives warning, error to user | +| `warning` | Provides custom warnings to user | +| `what` | A function that ... | +| `is` | A function that ... | +| `get` | A function that ... | **NOTE:** It is strongly encouraged that each `@keyword` and `@family` are to be identical. This eases the burden of development and maintenance for admiral functions. If you need to use multiple keywords or families, please reach out to the core development team for discussion.