Closes #81 #92 #93 #94 #95 #96 #97 #99: Various updates

.Rbuildignore

@@ -4,7 +4,7 @@
 ^pkgdown$
 ^_pkgdown\.yml$
 ^.github$
-^.lintr$
+^.lintr.R$
 ^docs$
 ^Meta$
 ^codecov\.yml$

.github/CODEOWNERS

@@ -2,4 +2,3 @@
 # Code owners are automatically requested for review when someone opens a pull request
 # that modifies code that they own. In this instance, cicdguy will be notified of any
 # changes made the files inside the .github/workflows directory.
-.github/workflows/* @cicdguy

.lintr.R

@@ -0,0 +1,15 @@
+# source in temporary environment to avoid changing the global environment
+temp_env <- new.env(parent = globalenv())
+
+source(system.file("lintr/linters.R", package = "admiraldev"), local = temp_env)
+
+linters <- temp_env$admiral_linters()
+
+# remove temporary environment to avoid lintr warning regarding "unused settings"
+rm(temp_env)
+
+exclusions <- list(
+  "R/data.R" = Inf,
+  "inst" = list(undesirable_function_linter = Inf),
+  "vignettes" = list(undesirable_function_linter = Inf)
+)

DESCRIPTION

@@ -2,8 +2,10 @@ Type: Package
 Package: admiraltemplate
 Title: ADaM in R Asset Library - Extension Package for `<<INSERT TA>>`
 Version: 0.1.0
-Authors@R: 
-    person("Open", "Source", , "admiraltemplate@pharmaverse.com", role = c("aut", "cre"))
+Authors@R: c(
+    person("Open", "Source", , "admiraltemplate@pharmaverse.com", role = c("aut", "cre")),
+    person("Company", role = c("cph", "fnd"))
+  )
 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
@@ -19,9 +21,9 @@ URL: https://pharmaverse.github.io/admiraltemplate,
 Depends: 
     R (>= 4.1)
 Imports:
-    admiral (>= 1.0.0),
-    admiraldev (>= 1.0.0),
-    dplyr (>= 1.0.5),
+    admiraldev (>= 1.4.0),
+    cli (>= 3.6.2),
+    dplyr (>= 1.1.1),
     hms (>= 0.5.3),
     lifecycle (>= 0.1.0),
     lubridate (>= 1.7.4),
@@ -34,20 +36,23 @@ Imports:
 Suggests:
     diffdf,
     DT,
+    here,
     htmltools,
     knitr,
     methods,
-    pharmaversesdtm (>= 0.2.0),
+    pharmaversesdtm (>= 1.0.0),
     reactable,
     readxl,
     rmarkdown,
     testthat (>= 3.0.0),
-    tibble
+    tibble,
+    withr
 VignetteBuilder: 
     knitr
 Config/testthat/edition: 3
 Encoding: UTF-8
 Language: en-US
 LazyData: true
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.1
+Roxygen: list(markdown = TRUE, roclets = c("collate", "namespace",
+    "admiraldev::rdx_roclet"))
+RoxygenNote: 7.3.3

LICENSE.md

@@ -179,7 +179,7 @@ recommend that a file or class name and description of purpose be included on
 the same "printed page" as the copyright notice for easier identification within
 third-party archives.
 
-    Copyright `<<INSERT YEAR>>` `<<INSERT CO-DEVELOPMENT PARTNER COMPANIES AS LICENSE HOLDERS>>`
+    Copyright `Year: <<INSERT YEAR>>` `License Holders: <<INSERT CO-DEVELOPMENT PARTNER COMPANIES AS LICENSE HOLDERS>>`
 
     Licensed under the Apache License, Version 2.0 (the "License");
     you may not use this file except in compliance with the License.

R/my_first_fcn.R

@@ -2,14 +2,18 @@
 #'
 #' Says hello admiral
 #'
-#' @param hw TRUE or FALSE
+#' @param hw Boolean determining whether a hello message is returned.
+#'
+#' @permitted [boolean]
 #'
 #' @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.
+#' You will also find custom permitted text under `./man/roxygen/rdx_meta.R` to
+#' standardize argument text.
 #'
-#' @return Happy Message
+#' @return A message
 #'
 #' @family der_adxx
 #'
@@ -18,11 +22,12 @@
 #' @export
 #'
 #' @examples
+#' hello_admiral()
 #' hello_admiral(hw = FALSE)
 hello_admiral <- function(hw = TRUE) {
   if (hw) {
     message("Welcome to the admiral family!")
   } else {
-    message("Welcome to the admiral family!")
+    message("<crickets>")
   }
 }