diff --git a/.gitignore b/.gitignore index e555c0a..8c2b98f 100644 --- a/.gitignore +++ b/.gitignore @@ -51,3 +51,5 @@ rsconnect/ # other next_actions.md docs +CRAN-SUBMISSION +cran-comments.md diff --git a/DESCRIPTION b/DESCRIPTION index 91dfb35..90fe833 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,17 +1,16 @@ 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 - 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/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: diff --git a/cran-comments.md b/cran-comments.md index e1abb22..0037a2f 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,5 +1,3 @@ ## R CMD check results -0 errors | 0 warnings | 1 note - -- This is a new release. +0 errors | 0 warnings | 0 notes 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: