From 0a3ab9f6ce370a0b3e26b9cc4ece40b27b182ab4 Mon Sep 17 00:00:00 2001 From: Matt Heaphy Date: Sat, 20 Jan 2024 21:24:14 -0500 Subject: [PATCH 1/5] news and readme update --- NEWS.md | 2 +- README.Rmd | 6 ++++++ README.md | 6 ++++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index 6bdd9b3..b79a634 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ # offsetreg 1.0.0 -- Initial CRAN submission +- Initial CRAN release - offsetreg includes one model specification, `poisson_reg_offset()` with support for two engines: `glm_offset()` and `glmnet_offset()`, which are wrappers around `stats::glm()` and `glmnet::glmnet()`, respectively. diff --git a/README.Rmd b/README.Rmd index 5d87efb..3d214cf 100644 --- a/README.Rmd +++ b/README.Rmd @@ -45,6 +45,12 @@ Model engines ## Installation +The offsetreg package can be installed from CRAN with: + +``` r +install.packages("offsetreg") +``` + You can install the development version of offsetreg from [GitHub](https://github.com/) with: ``` r diff --git a/README.md b/README.md index df23500..5106935 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,12 @@ Model engines ## Installation +The offsetreg package can be installed from CRAN with: + +``` r +install.packages("offsetreg") +``` + You can install the development version of offsetreg from [GitHub](https://github.com/) with: From 5592c519a63cd639e59969109796f6c6f3721b9a Mon Sep 17 00:00:00 2001 From: Matt Heaphy Date: Sat, 20 Jan 2024 21:31:29 -0500 Subject: [PATCH 2/5] gitignore update --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index e555c0a..eaa5d9a 100644 --- a/.gitignore +++ b/.gitignore @@ -51,3 +51,4 @@ rsconnect/ # other next_actions.md docs +CRAN-SUBMISSION From c3fdf5d81b1be9cd5a38839cb1454075c2e7c95b Mon Sep 17 00:00:00 2001 From: Matt Heaphy Date: Sun, 21 Jan 2024 11:01:09 -0500 Subject: [PATCH 3/5] Description updates from CRAN submission --- DESCRIPTION | 6 +++--- cran-comments.md | 7 ++++++- man/offsetreg-package.Rd | 4 ++-- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 91dfb35..9055584 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,11 +1,11 @@ Package: offsetreg -Title: An Extension of Tidymodels Supporting Offset Terms +Title: An Extension of 'Tidymodels' Supporting Offset Terms Version: 1.0.0 Authors@R: person("Matt", "Heaphy", email = "mattrmattrs@gmail.com", role = c("aut", "cre", "cph")) Maintainer: Matt Heaphy -Description: This package provides functions that extend the 'tidymodels' - ecosystem to enable usage of predictive models +Description: This package extends the 'tidymodels' ecosystem + to enable usage of predictive models with offset terms. Models with offsets are most useful when working with count data or when fitting an adjustment model on top of an existing model with a prior expectation. The former situation is common in insurance where diff --git a/cran-comments.md b/cran-comments.md index e1abb22..19180f1 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -2,4 +2,9 @@ 0 errors | 0 warnings | 1 note -- This is a new release. +- This is a re-submission of a new release. Thank you for the very prompt + response. +- Two notes from the manual review have been adjusted: (1) The redundant phrase + 'this packages' provides was removed from the Description field. (2) Names + of other software in the title and description are now in single quotes ( + ex: 'tidymodels'). diff --git a/man/offsetreg-package.Rd b/man/offsetreg-package.Rd index 1f14816..c03b1c5 100644 --- a/man/offsetreg-package.Rd +++ b/man/offsetreg-package.Rd @@ -4,9 +4,9 @@ \name{offsetreg-package} \alias{offsetreg} \alias{offsetreg-package} -\title{offsetreg: An Extension of Tidymodels Supporting Offset Terms} +\title{offsetreg: An Extension of 'Tidymodels' Supporting Offset Terms} \description{ -This package provides functions that extend the 'tidymodels' ecosystem \url{https://www.tidymodels.org/} to enable usage of predictive models with offset terms. Models with offsets are most useful when working with count data or when fitting an adjustment model on top of an existing model with a prior expectation. The former situation is common in insurance where data is often weighted by exposures. The latter is common in life insurance where industry mortality tables are often used as a starting point for setting assumptions. +This package extends the 'tidymodels' ecosystem \url{https://www.tidymodels.org/} to enable usage of predictive models with offset terms. Models with offsets are most useful when working with count data or when fitting an adjustment model on top of an existing model with a prior expectation. The former situation is common in insurance where data is often weighted by exposures. The latter is common in life insurance where industry mortality tables are often used as a starting point for setting assumptions. } \seealso{ Useful links: From bd78477f77238e8bb1d0688ef90f4bc36fbd8678 Mon Sep 17 00:00:00 2001 From: Matt Heaphy Date: Mon, 22 Jan 2024 20:03:03 -0500 Subject: [PATCH 4/5] CRAN comments update --- DESCRIPTION | 15 +++++++-------- cran-comments.md | 12 +++++------- 2 files changed, 12 insertions(+), 15 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 9055584..90fe833 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -4,14 +4,13 @@ Version: 1.0.0 Authors@R: person("Matt", "Heaphy", email = "mattrmattrs@gmail.com", role = c("aut", "cre", "cph")) Maintainer: Matt Heaphy -Description: This package extends the 'tidymodels' ecosystem - to enable usage of predictive models - with offset terms. Models with offsets are most useful when working with - count data or when fitting an adjustment model on top of an existing model - with a prior expectation. The former situation is common in insurance where - data is often weighted by exposures. The latter is common in life insurance - where industry mortality tables are often used as a starting point for - setting assumptions. +Description: Extend the 'tidymodels' ecosystem to + enable the creation of predictive models with offset terms. Models with + offsets are most useful when working with count data or when fitting an + adjustment model on top of an existing model with a prior expectation. + The former situation is common in insurance where data is often weighted by + exposures. The latter is common in life insurance where industry mortality + tables are often used as a starting point for setting assumptions. License: MIT + file LICENSE URL: https://github.com/mattheaphy/offsetreg/, https://mattheaphy.github.io/offsetreg/ BugReports: https://github.com/mattheaphy/offsetreg/issues diff --git a/cran-comments.md b/cran-comments.md index 19180f1..d846166 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,10 +1,8 @@ ## R CMD check results -0 errors | 0 warnings | 1 note +0 errors | 0 warnings | 0 notes -- This is a re-submission of a new release. Thank you for the very prompt - response. -- Two notes from the manual review have been adjusted: (1) The redundant phrase - 'this packages' provides was removed from the Description field. (2) Names - of other software in the title and description are now in single quotes ( - ex: 'tidymodels'). +- This is a re-submission of a new release. +- The last submission included the comment, "The Description field should not + start with the package name, 'This package' or similar." The Description + field has since been modified and now begins with "Extend". From 2abc65a277a4ece09fa485f88f3f035985fcdfe6 Mon Sep 17 00:00:00 2001 From: Matt Heaphy Date: Tue, 23 Jan 2024 10:19:48 -0500 Subject: [PATCH 5/5] cran comments update --- .gitignore | 1 + cran-comments.md | 5 ----- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index eaa5d9a..8c2b98f 100644 --- a/.gitignore +++ b/.gitignore @@ -52,3 +52,4 @@ rsconnect/ next_actions.md docs CRAN-SUBMISSION +cran-comments.md diff --git a/cran-comments.md b/cran-comments.md index d846166..0037a2f 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,8 +1,3 @@ ## R CMD check results 0 errors | 0 warnings | 0 notes - -- This is a re-submission of a new release. -- The last submission included the comment, "The Description field should not - start with the package name, 'This package' or similar." The Description - field has since been modified and now begins with "Extend".