Removed contributing document. Created quote and quosure section. Cre…

…ated dear dev section

R/quo.R

@@ -6,7 +6,8 @@
 #'
 #' @author Thomas Neitmann
 #'
-#' @keywords dev_utility
+#' @keywords quo
+#' @family quo
 #'
 #' @rdname dev_util_quo_c
 #'
@@ -30,6 +31,9 @@ quo_c <- function(...) {
 #'
 #' @author Thomas Neitmann, Ondrej Slama
 #'
+#' @keywords quo
+#' @family quo
+#'
 #' @noRd
 #'
 #' @examples

R/quote.R

@@ -6,7 +6,8 @@
 #'
 #' @author Thomas Neitmann
 #'
-#' @keywords dev_utility
+#' @keywords quo
+#' @family quo
 #'
 #' @rdname dev_util_enumerate
 #'
@@ -36,7 +37,8 @@ enumerate <- function(x, quote_fun = backquote, conjunction = "and") {
 #'
 #' @author Thomas Neitmann
 #'
-#' @keywords dev_utility
+#' @keywords quo
+#' @family quo
 #'
 #' @rdname dev_util_backquote
 #'
@@ -52,7 +54,8 @@ backquote <- function(x) {
 #'
 #' @author Thomas Neitmann
 #'
-#' @keywords dev_utility
+#' @keywords quo
+#' @family quo
 #'
 #' @rdname dev_util_squote
 #'
@@ -74,7 +77,8 @@ squote <- function(x) {
 #'
 #' @author Stefan Bundfuss
 #'
-#' @keywords dev_utility
+#' @keywords quo
+#' @family quo
 #'
 #' @examples
 #' admiral:::dquote("foo")

README.Rmd

@@ -41,10 +41,12 @@ ADaM in R Asset Library Development Utilities
 
 ## Purpose
 
-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. 
+Tools for developing functions and maintaining a healthy code base 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 currently not recommended. 
 
 ## Installation
 
+The package is available from CRAN and can be installed by running install.packages("admiraldev").
+
 To install the latest development version of the package directly from GitHub use the following code:
 
 ```{r, eval = FALSE}
@@ -53,14 +55,11 @@ if (!requireNamespace("remotes", quietly = TRUE)) {
 }
 
 remotes::install_github("pharmaverse/admiraldev", ref = "devel")
-remotes::install_github("pharmaverse/admiral.test", ref = "devel")
-remotes::install_github("pharmaverse/admiral", ref = "devel")
-
 ```
 
 ## Release Schedule
 
-`{admiraldev}` is to be release one week before the release of `{admiral}`.  You can find the release schedule for `{admiral}` packages here(TBL)
+`{admiraldev}` is to be release one week before the release of `{admiral}`.  You can find the release schedule for `{admiral}` packages [here](https://github.com/pharmaverse/admiral/tree/devel#release-schedule)
 
 
 

README.md

@@ -9,13 +9,17 @@ ADaM in R Asset Library Development Utilities
 
 ## Purpose
 
-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.
+Tools for developing functions and maintaining a healthy code base
+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 currently not
+recommended.
 
 ## Installation
 
+The package is available from CRAN and can be installed by running
+install.packages(“admiraldev”).
+
 To install the latest development version of the package directly from
 GitHub use the following code:
 
@@ -24,11 +28,9 @@ GitHub use the following code:
     }
 
     remotes::install_github("pharmaverse/admiraldev", ref = "devel")
-    remotes::install_github("pharmaverse/admiral.test", ref = "devel")
-    remotes::install_github("pharmaverse/admiral", ref = "devel")
 
 ## Release Schedule
 
 `{admiraldev}` is to be release one week before the release of
 `{admiral}`. You can find the release schedule for `{admiral}` packages
-here(TBL)
+[here](https://github.com/pharmaverse/admiral/tree/devel#release-schedule)

_pkgdown.yml

@@ -17,7 +17,7 @@ news:
 
 reference:
 - title: Assertion Functions
-  desc: Checks inputs for functions and provide error and messaging around those checks
+  desc: Checks the inputs for user-faceing functions and provides error, warnings and other messaging around expectation of inputs.
   contents:
   - has_keyword('assertion')
 
@@ -46,8 +46,13 @@ reference:
   contents:
   - has_keyword('test_helper')
 
+- title: Quosure and Quoting Helper Functions
+  desc: Helping your quoting and quosure needs
+  contents:
+  - has_keyword('quo')
+
 - title: Developer Utility Functions
-  desc: Utilities to help with organization and documenation
+  desc: General Utilities
   contents:
   - has_keyword('dev_utility')
 
@@ -60,12 +65,10 @@ navbar:
     text: Developer Guides
     menu:
     - text: Overview
-    - text: Contribution to {admiral}
-      href: articles/contribution_model.html
     - text: Development Process
       href: articles/development_process.html
     - text: -------
-    - text: "All things development"
+    - text: "{admiral} development processes"
     - text: Programming Strategy
       href: articles/programming_strategy.html
     - text: Guidance for git and GitHub Usage

man/roxygen/meta.R

@@ -3,7 +3,7 @@ list(
     is = "Identifies type of Object with return of TRUE/FALSE: ",
     assertion = "Checks for valid input and returns warning or errors messages: ",
     what = "Identifies type of object and returns type: ",
-    quo = "Helps for working with Quosures: ",
+    quo = "Helpers for working with Quosures and Quoting: ",
     get = "Brings something to you!?!: ",
     test_helper = "Helps with Testing: ",
     dev_utility = "Developer Utility Functions: ",

vignettes/admiraldev.Rmd

@@ -1,10 +1,10 @@
 ---
-title: "Contribution to {admiral} and {admiraldev}"
+title: "Get Started"
 output: 
   rmarkdown::html_vignette
 
 vignette: >
-  %\VignetteIndexEntry{Contribution to {admiral} and {admiraldev}}
+  %\VignetteIndexEntry{Get Started}
   %\VignetteEngine{knitr::rmarkdown}
 ---
 
@@ -16,4 +16,25 @@ knitr::opts_chunk$set(
 ```
 
 
-Some stuff here...
+#  Dear Developers
+
+`{admiraldev}` is intended for you, the developer, to help make developing within the admiral family easier and consistently robust and maybe even fun!  
+
+Tools are loosely defined as follows:
+
+* Utility Functions used in `{admiral}` and `{admiral}` extension functions for doing custom checks and providing custom messages, warnings and errors.  These cusotm messages, warnings and errors are succint, but helpful messaging around what a function expects as inputs. The inputs to admiral functions are many, but generally fit into three categories: datasets, variables and arguments. Most of the functions start with `assert_`, `is_` or `get_`.
+
+* Addins and utility functions that help with documentation, testing and checking on health of the code base in all admiral packages.
+
+* Vignettes on working on `{admiral}` functions, developing unit testing, releases process, vignette writing and other documenation.  These vignettes are intended for use across admiral packages.
+
+# Adding new tools
+
+* Just like in `{admiral}`, we follow the same procedures of adding issues, developing those issues in branches and doing a Pull Request.  
+
+* Experimental tools are highly encouraged to help reduce repetitive patterns and automating the boring stuff.  
+
+
+
+
+