News file update. Typos and prose adjusted

NEWS.md

@@ -1,23 +1,24 @@
-# admiraldev 0.0.1
+# admiraldev 0.1.0
 
 ## New Features
 
-- You can link the GitHub Issue to Changelog by using (#ISSUE-NUMBER)
+  - Developer specific functions brought over from `{admiral}`
+  - Developer specific vignettes brought over from `{admiral}`
+  - New `{admiraldev}` website created
 
 ## Updates of Existing Functions
 
- - Updates that you have made for this version (#ISSUE-NUMBER)
+  - NA
 
 ## Breaking Changes
 
- - Deprecated functions. (#ISSUE-NUMBER)
- - Bug Fixes (#ISSUE-NUMBER)
+  - NA
 
 ## Documentation
 
- - Stuff that you did (#ISSUE-NUMBER)
+  - NA
 
 ## Various
 
- - Stuff that you did (#ISSUE-NUMBER)
+  - NA
 

README.Rmd

@@ -41,7 +41,9 @@ ADaM in R Asset Library Development Utilities
 
 ## Purpose
 
-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. 
+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. 
+
+**NOTE:** Use of this package as a standalone package is currently not recommended. 
 
 ## Installation
 
@@ -59,7 +61,7 @@ remotes::install_github("pharmaverse/admiraldev", 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](https://github.com/pharmaverse/admiral/tree/devel#release-schedule)
+`{admiraldev}` is to be official released to CRAN 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

@@ -12,7 +12,8 @@ ADaM in R Asset Library Development Utilities
 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
+
+**NOTE:** Use of this package as a standalone package is currently not
 recommended.
 
 ## Installation
@@ -31,6 +32,7 @@ GitHub use the following code:
 
 ## Release Schedule
 
-`{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)
+`{admiraldev}` is to be official released to CRAN 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).

_pkgdown.yml

@@ -17,7 +17,7 @@ news:
 
 reference:
 - title: Assertion Functions
-  desc: Checks the inputs for user-faceing functions and provides error, warnings and other messaging around expectation of inputs.
+  desc: Checks the inputs for user-facing functions and provides error, warnings and other messaging around expectation of inputs.
   contents:
   - has_keyword('assertion')
 
@@ -37,7 +37,7 @@ reference:
   - has_keyword('what')
 
 - title: Warning Functions
-  desc: Custom warnings for users
+  desc: Custom warnings intended for users
   contents:
   - has_keyword('warnings')
 

vignettes/admiraldev.Rmd

@@ -18,23 +18,25 @@ knitr::opts_chunk$set(
 
 #  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!  
+`{admiraldev}` is a set of tools intended for you, the developer, to help make developing within the admiral family easier, consistently robust across all packages 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_`.
+* Utility Functions used in `{admiral}` and `{admiral}` extension functions for doing custom checks and providing custom messages, warnings and errors.  These custom messages, warnings and errors are succinct, 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.
+* Vignettes on working on `{admiral}` functions, developing unit testing, releases process, vignette writing and other documentation needs.  These vignettes are intended for use across all 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.  
 
+# Why have a separate development package?
 
+As the `{admiral}` package function base has grown it was decided to create extension packages for use within companies and specific TAs to help with specific problems. We intended these extension packages to follow the same processes as `{admiral}` core, e.g. Unit Testing, Roxygen Documentation, Function Design.  A standalone development package allows us to keep an up to date development process for all developers across the family.  We also feel that a lot of the developer functions are not user-specific and gives us more freedom to create and release utility tools specific to our family of packages.