feat (WIP): Mean age of childbearing #61

spencerpease · 2020-09-01T19:21:28Z

Describe changes

Adds a function macb_from_nfx(), which calculates mean age of childbearing.

What issues are related

Fixes #60

Related to #19

Checklist

Packages Repositories

Have you read the contributing guidelines for ihmeuw-demographics R packages?
Have you successfully run devtools::check() locally?
Have you updated or added function (and vignette if applicable) documentation? Did you update the 'man' and 'NAMESPACE' files with devtools::document()?
Have you added in tests for the changes included in the PR?
Do the changes follow the ihmeuw-demographics code style?
Do your changes need to be immediately included in a new build of docker-base or docker-internal? If so follow directions in those repositories to rebuild and redeploy the images.

Other Repositories

Did you update any relevant documentation (README.md, script headers, wiki pages, internal IHME hub pages etc.)?
Could someone else on the ihmeuw-demographics team replicate or use your work using available documentation?
Did you test your work? Either via automated tests or documented manual testing?

Details of PR

Include other information helpful for reviewers.

Did you reference other sources in order to make the changes in the PR? Link those here or include in actual documentation as part of the PR changes.

This defines the API and core calculation for calculating MACB from an input `data.table`. References #60, #19

chacalle · 2020-09-08T18:06:32Z

Could maybe use this for example test data https://www.measureevaluation.org/prh/rh_indicators/family-planning/fertility/total-fertility-rate

chacalle · 2020-09-08T18:25:08Z

https://stats.stackexchange.com/questions/320712/what-does-mean-age-at-childbearing-mean

references #60, #19

References #60, #19

krpaulson · 2020-09-08T18:36:56Z

R/mcab.R

+#' @param dt \[`data.table()`\]\cr A data.table with columns 'age_start',
+#'   'age_end', and a column of fertility rates named after `nfx_col`.
+#' @param nfx_col \[`character(1)`\]\cr Name of fertility rate column in `dt`.
+#'   Defualts to "nfx".


Also, we should use standard notation nfx in other functions instead of asfr.

krpaulson · 2020-09-08T18:38:16Z

R/mcab.R

+#' @param nfx_col \[`character(1)`\]\cr Name of fertility rate column in `dt`.
+#'   Defualts to "nfx".
+#' @inheritParams gen_lifetable_parameters
+#' @param value_col \[`character(1)`\]\cr Name of output 'MACB' column. Defaults


When would you not just want this to be mcab? We don't have this option in other functions.

krpaulson · 2020-09-08T18:39:01Z

R/mcab.R

+#'
+#' @export
+#'
+#' @examples


TODO: add example(s)

krpaulson · 2020-09-08T18:39:50Z

R/mcab.R

+    assertthat::is.string(nfx_col),
+    assertthat::is.string(value_col)
+  )
+


Add more checks for dt and id_cols.

krpaulson · 2020-09-08T18:42:34Z

R/mcab.R

+
+  macb_dt <- dt[
+    ,
+    .(macb = weighted.mean((age_end + age_start) / 2, get(nfx_col))),


I like to use list instead of . in the packages. Thoughts?

Where does the weighted.mean function come from?

krpaulson · 2020-09-08T18:45:15Z

R/mcab.R

+#'
+#' @return \[`data.table()`\] A data.table with calculated 'MACB' for each
+#'   unique grouping in `id_cols`, stored in `value_col`.
+#'


Add @details section with equation?

meghanfrisch · 2020-09-08T18:45:34Z

R/mcab.R

+#' @param dt \[`data.table()`\]\cr A data.table with columns 'age_start',
+#'   'age_end', and a column of fertility rates named after `nfx_col`.
+#' @param nfx_col \[`character(1)`\]\cr Name of fertility rate column in `dt`.
+#'   Defualts to "nfx".


Spelling error

meghanfrisch · 2020-09-08T18:55:41Z

R/mcab.R

+#' @inheritParams gen_lifetable_parameters
+#' @param value_col \[`character(1)`\]\cr Name of output 'MACB' column. Defaults
+#'   to "mcab"
+#'


could add @seealso for where to find more information on MACB

feat: Inital setup of MACB function

bf76151

This defines the API and core calculation for calculating MACB from an input `data.table`. References #60, #19

spencerpease added enhancement New feature or request good first issue Good for newcomers labels Sep 1, 2020

spencerpease changed the title ~~FEAT: MACB function (WIP)~~ feat (WIP): MACB function Sep 1, 2020

spencerpease changed the title ~~feat (WIP): MACB function~~ feat (WIP): Mean age of childbearing function Sep 1, 2020

spencerpease changed the title ~~feat (WIP): Mean age of childbearing function~~ feat (WIP): Mean age of childbearing Sep 1, 2020

spencerpease added 4 commits September 8, 2020 11:32

fix: Output column naming of macb_from_nfx()

ccf14d6

references #60, #19

test: add macb tests

ab6602a

references #60, #19

docs: Add macb

bf26275

docs: Add macb example

1b2decb

References #60, #19

krpaulson reviewed Sep 8, 2020

View reviewed changes

meghanfrisch reviewed Sep 8, 2020

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat (WIP): Mean age of childbearing #61

feat (WIP): Mean age of childbearing #61

spencerpease commented Sep 1, 2020 •

edited

Loading

chacalle commented Sep 8, 2020

chacalle commented Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

krpaulson Sep 8, 2020

meghanfrisch Sep 8, 2020

meghanfrisch Sep 8, 2020

feat (WIP): Mean age of childbearing #61

Are you sure you want to change the base?

feat (WIP): Mean age of childbearing #61

Conversation

spencerpease commented Sep 1, 2020 • edited Loading

Describe changes

What issues are related

Checklist

Packages Repositories

Other Repositories

Details of PR

chacalle commented Sep 8, 2020

chacalle commented Sep 8, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

spencerpease commented Sep 1, 2020 •

edited

Loading