Skip to content

Commit

Permalink
Fixing hex image. Reducing baggage for readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
@bms63
bms63 committed Aug 8, 2022
1 parent 224d27b commit ae3574e
Show file tree
Hide file tree
Showing 15 changed files with 25 additions and 211 deletions.
54 changes: 8 additions & 46 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```

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

# admiraldev - ADaM in R Asset Library Development Utilities
# admiraldev <img src="man/figures/logo.png" align="right" alt="" width="120" />

ADaM in R Asset Library Development Utilities

<img src="man/figures/admiraldev.png" align="right" width="200" style="margin-left:50px;"/>

<!-- badges: start -->
## To Do Update Badges
<!-- badges: end -->


## 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

Expand All @@ -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)



Expand Down
174 changes: 10 additions & 164 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
<!-- Please do not edit the README.md file as it is auto-generated. Only edit the README.Rmd file -->

# admiraldev - ADaM in R Asset Library Development Utilities
# admiraldev <img src="man/figures/logo.png" align="right" alt="" width="120" />

<img src="man/figures/admiraldev.png" align="right" width="200" style="margin-left:50px;"/>
ADaM in R Asset Library Development Utilities

<!-- badges: start -->

## To Do Update Badges

<!-- badges: end -->

## 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

Expand All @@ -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

<table>
<colgroup>
<col style="width: 40%" />
<col style="width: 59%" />
</colgroup>
<thead>
<tr class="header">
<th>Keyword</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><code>assertion</code></td>
<td>Asserts a certain type and gives warning, error to user</td>
</tr>
<tr class="even">
<td><code>warning</code></td>
<td>Provides custom warnings to user</td>
</tr>
<tr class="odd">
<td><code>what</code></td>
<td>A function that …</td>
</tr>
<tr class="even">
<td><code>is</code></td>
<td>A function that …</td>
</tr>
<tr class="odd">
<td><code>get</code></td>
<td>A function that …</td>
</tr>
</tbody>
</table>
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`

<table>
<colgroup>
<col style="width: 24%" />
<col style="width: 25%" />
<col style="width: 24%" />
<col style="width: 25%" />
</colgroup>
<thead>
<tr class="header">
<th>Release Schedule</th>
<th>Phase 1- Date and Packages</th>
<th>Phase 2- Date and Packages</th>
<th>Phase 3- Date and Packages</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td>Q3-2022</td>
<td>August 29th</td>
<td>September 5th</td>
<td>September 12th</td>
</tr>
<tr class="even">
<td></td>
<td><code>admiraldev</code></td>
<td><code>admiral</code></td>
<td><code>admiralonco</code></td>
</tr>
<tr class="odd">
<td></td>
<td><code>admiral.test</code></td>
<td></td>
<td><code>admiralroche</code></td>
</tr>
<tr class="even">
<td>Q4-2022</td>
<td>November 28th</td>
<td>December 5th</td>
<td>December 12th</td>
</tr>
<tr class="odd">
<td></td>
<td><code>admiraldev</code></td>
<td><code>admiral</code></td>
<td><code>admiralonco</code></td>
</tr>
<tr class="even">
<td></td>
<td><code>admiral.test</code></td>
<td></td>
<td><code>admiralroche</code></td>
</tr>
<tr class="odd">
<td>Q1-2023</td>
<td>February 27th</td>
<td>March 6th</td>
<td>March 13th</td>
</tr>
<tr class="even">
<td></td>
<td><code>admiraldev</code></td>
<td><code>admiral</code></td>
<td><code>admiralonco</code></td>
</tr>
<tr class="odd">
<td></td>
<td><code>admiral.test</code></td>
<td></td>
<td><code>admiralroche</code></td>
</tr>
<tr class="even">
<td>Q2-2023</td>
<td>May 29th</td>
<td>June 5th</td>
<td>June 12th</td>
</tr>
<tr class="odd">
<td></td>
<td><code>admiraldev</code></td>
<td><code>admiral</code></td>
<td><code>admiralonco</code></td>
</tr>
<tr class="even">
<td></td>
<td><code>admiral.test</code></td>
<td></td>
<td><code>admiralroche</code></td>
</tr>
</tbody>
</table>
`{admiraldev}` is to be release one week before the release of
`{admiral}`. You can find the release schedule for `{admiral}` packages
here(TBL)
Binary file removed man/figures/admiraldev.png
View file
Binary file not shown.
Binary file modified man/figures/logo.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-120x120.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-152x152.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-180x180.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-60x60.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon-76x76.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/apple-touch-icon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-16x16.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon-32x32.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified pkgdown/favicon/favicon.ico
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion vignettes/admiraldev.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ output:
rmarkdown::html_vignette

vignette: >
%\VignetteIndexEntry{Contribution to {admiraldev}}
%\VignetteIndexEntry{Contribution to {admiral} and {admiraldev}}
%\VignetteEngine{knitr::rmarkdown}
---

Expand Down
6 changes: 6 additions & 0 deletions vignettes/programming_strategy.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit ae3574e

Please sign in to comment.