Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Closes #2115 - references to pharmaversesdtm and pharmaverse adam #2129

Merged
merged 4 commits into from
Oct 6, 2023
Merged

Closes #2115 - references to pharmaversesdtm and pharmaverse adam #2129

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0c42c34
#2115: added references to pharmaversesdtm and pharmaverse adam. Corr…
manciniedoardo Sep 26, 2023
560c3b5
#2115 chore: spellcheck
manciniedoardo Sep 26, 2023
1930d81
#2115 updates following review
manciniedoardo Sep 28, 2023
1e8b859
Merge branch 'main' into 2115_mention_pharmaverseadam
manciniedoardo Sep 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ remotes::install_github("pharmaverse/admiral")

## Release Schedule

[{admiral}](https://pharmaverse.github.io/admiral/cran-release/)` releases are targeted for the first Monday of the last month of each quarter. Pull Requests will be frozen the week before a release.
[{admiral}](https://pharmaverse.github.io/admiral/cran-release/) releases are targeted for the first Monday of the last month of each quarter. Pull Requests will be frozen the week before a release.
manciniedoardo marked this conversation as resolved.
Show resolved Hide resolved
The {admiral} family has several downstream and upstream dependencies and so this release shall be done in three
Phases:

Expand Down Expand Up @@ -79,15 +79,24 @@ We will provide:
* Vignettes on how to create ADSL, BDS and OCCDS datasets, including example scripts
* Vignettes for ADaM dataset specific functionality (i.e. dictionary coding, date imputation, SMQs ...)

## Types of Packages
## The {admiral} Family of Packages

There will be 3 foreseeable types of `{admiral}` packages:
There are three types of packages in the `{admiral}` family:

* Core package---one package containing all core functions required to create ADaMs, usable by any company (i.e. general derivations, utility functions and checks for ADSL, OCCDS and BDS)
* TA (Therapeutic Area) package extensions---one package per TA with functions that are
specific to algorithms and requirements for that particular TA (e.g. [`{admiralonco}`](https://pharmaverse.github.io/admiralonco/))
* Company package extensions---specific needs and plug-ins for the company, such as access to metadata
(e.g. `{admiralroche}` or `{admiralgsk}`)

## Related Data Packages
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we talk about xportr, metacore and metatools for related ADaM needs?? Maybe sdtmchecks or oak could get a brief shout out??

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added mention of xportr, metacore and metatools - thanks for the suggestion. As this is in a "related ADaM needs" section I omitted mentioning sdtmchecks and oak which are more focused on SDTM.


Also available in the pharmaverse are:

* [{pharmaversesdtm}](https://pharmaverse.github.io/pharmaversesdtm/main/)---this contains test SDTM data sourced from the [CDISC pilot project](https://github.com/cdisc-org/sdtm-adam-pilot-project) or constructed ad-hoc by the `{admiral}` team. This is a prerequisite package for `{admiral}`.
* [{pharmaverseadam}](https://pharmaverse.github.io/pharmaverseadam/main/)---this contains test ADaM data automatically generated by running the ADaM `{admiral}` and TA package extensions templates on the [{pharmaversesdtm}](https://pharmaverse.github.io/pharmaversesdtm/main/) data.

Both these packages are developed by the `{admiral}` team, but can used across the pharmaverse as common, open-source test SDTM or ADaM data.

## Admiral Manifesto

Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,7 @@ onwards
parttime
pharmaverse
pharmaversesdtm
pharmaverseadam
phosphatase
poppk
pre
Expand Down
Loading