Skip to content

Commit

Permalink
#1 Reverted changes made to package name, testthat.R, NEWS.md, DESCRI…
Browse files Browse the repository at this point in the history
…PTION and _pkgdown.yml
  • Loading branch information
gg106046 committed Jul 28, 2023
1 parent 190cfdc commit 87a96c2
Show file tree
Hide file tree
Showing 12 changed files with 126 additions and 42 deletions.
16 changes: 10 additions & 6 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
Package: pharmaverseadam
Package: admiraltemplate
Type: Package
Title: ADaM Test Data for the Pharmaverse Family of Packages
Version: 0.0.1
Title: ADaM in R Asset Library - Extension
Version: 0.0.2
Authors@R: c(
person("Edoardo", "Mancini", email = "[email protected]", role = c("aut", "cre")))
Description: A set of Analysis Data Model (ADaM) datasets."
person("Open", "Source", email = "[email protected]", role = c("aut", "cre")))
Description: A toolbox for programming Clinical Data Standards Interchange Consortium
(CDISC) compliant Analysis Data Model (ADaM) datasets in R. ADaM datasets are a
mandatory part of any New Drug or Biologics License Application submitted to the
United States Food and Drug Administration (FDA). Analysis derivations are
implemented in accordance with the "Analysis Data Model Implementation Guide"
(CDISC Analysis Data Model Team, 2021, <https://www.cdisc.org/standards/foundational/adam/adamig-v1-3-release-package>).
License: Apache License (>= 2)
URL: https://pharmaverse.github.io/pharmaverseadam, https://github.com/pharmaverse/pharmaverseadam
URL: https://pharmaverse.github.io/admiraltemplate, https://github.com/pharmaverse/admiraltemplate
Encoding: UTF-8
Language: en-US
LazyData: true
Expand Down
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Generated by roxygen2: do not edit by hand

export(hello_admiral)
importFrom(admiral,derive_vars_dy)
importFrom(admiraldev,assert_character_scalar)
importFrom(admiraldev,assert_character_vector)
Expand Down
25 changes: 24 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# pharmaverseadam 0.0.1
# admiraltemplate 0.0.2

## New Features

- New `renv` lock files were setup (#48)

## Updates of Existing Functions

## Breaking Changes

## Documentation

- Many updates across documentation made to match v0.10.0 of `admiral` [PR #51](https://github.com/pharmaverse/admiraltemplate/pull/51), including:
- Links were fixed on the website
- Templates were aligned to current `admiral` standards
- Package dependencies were updated
- Explanation on how to use family/keywords have been provided

## Various

- Renamed from `admiralext` to `admiraltemplate`

# admiraltemplate 0.0.1

## New Features

Expand All @@ -20,3 +42,4 @@
## Various

- Stuff that you did (#ISSUE-NUMBER)

File renamed without changes.
28 changes: 28 additions & 0 deletions R/my_first_fcn.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#' Derive Extension Example
#'
#' Says hello admiral
#'
#' @param hw TRUE or FALSE
#'
#' @details In the roxygen documentation you will find tags for family and keywords.
#' This is to create organized sections for the Reference tab on the pkgdown website.
#' You can modify the `_pkgdown.yml` as necessary to create appropriate sections as necessary.
#' Under `./man/roxygen/meta.R`, you will find where to store these family/keywords.
#'
#' @return Happy Message
#'
#' @family der_adxx
#'
#' @keywords der_adxx
#'
#' @export
#'
#' @examples
#' hello_admiral(hw = FALSE)
hello_admiral <- function(hw = TRUE) {
if (hw) {
message("Welcome to the admiral family!")
} else {
message("Welcome to the admiral family!")
}
}
12 changes: 6 additions & 6 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
url: https://pharmaverse.github.io/pharmaverseadam
url: https://pharmaverse.github.io/admiraltemplate

template:
bootstrap: 5
params:
bootswatch: flatly
repo:
url:
home: https://github.com/pharmaverse/pharmaverseadam
source: https://github.com/pharmaverse/pharmaverseadam/blob/main/
issue: https://github.com/pharmaverse/pharmaverseadam/issues/
home: https://github.com/pharmaverse/admiraltemplate
source: https://github.com/pharmaverse/admiraltemplate/blob/main/
issue: https://github.com/pharmaverse/admiraltemplate/issues/
user: https://github.com/
news:
cran_dates: true
Expand All @@ -28,7 +28,7 @@ reference:

- title: Advanced Functions
- subtitle: Pre-Defined Source Objects
desc: Source objects defined by {pharmaverseadam}
desc: Source objects defined by {admiraltemplate}
- contents:
- has_keyword("source_specifications")

Expand Down Expand Up @@ -56,7 +56,7 @@ navbar:
components:
getstarted:
text: Get Started
href: articles/pharmaverseadam.html
href: articles/admiraltemplate.html
reference:
text: Reference
href: reference/index.html
Expand Down
File renamed without changes.
26 changes: 26 additions & 0 deletions man/admiraltemplate-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 28 additions & 0 deletions man/hello_admiral.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 0 additions & 26 deletions man/pharmaverseadam-package.Rd

This file was deleted.

4 changes: 2 additions & 2 deletions tests/testthat.R
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
library(testthat) # nolint: undesirable_function_linter
library(pharmaverseadam) # nolint: undesirable_function_linter
library(admiraltemplate) # nolint: undesirable_function_linter

test_check("pharmaverseadam")
test_check("admiraltemplate")
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ knitr::opts_chunk$set(
```

```{r eval=FALSE}
library(pharmaverseadam)
library(admiraltemplate)
```

Introduction to how to use the package extension...

0 comments on commit 87a96c2

Please sign in to comment.