Skip to content

Commit a88dfe9

Browse files
committed
Improve documentation
1 parent 73f549f commit a88dfe9

19 files changed

Lines changed: 41 additions & 47 deletions

R/gcdg_chn.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,5 +99,4 @@
9999
#' increases infant iron status at 9 mo without decreasing growth or increasing
100100
#' illness in a randomized clinical trial in rural China.
101101
#' The Journal of nutrition. 2016;146:612-621.
102-
#' \url{https://academic.oup.com/jn/article/146/3/612/4578262}
103102
"gcdg_chn"

R/gcdg_col_lt42m.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 1311 children measured at ages 0.5-3.5 year.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: ASQ screener (`aqi`), Battelle (`bat`), Bayley III (`by3`),
99
#' Denver (`den`) and WHO motor milestones (`mds`).
@@ -16,7 +16,7 @@
1616
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1717
#'| `cohort` | chr | Cohort name |
1818
#'| `cohortn` | chr | Cohort number |
19-
#'| `id` | int | Child number |
19+
#'| `subjid` | int | Child number |
2020
#'| `agedays` | int | Age (days) |
2121
#'| `sex` | chr | Either `"male"` or `"female"` |
2222
#'| `gagebrth` | int | Gestational age (days) |

R/gcdg_col_lt45m.R

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 707 unique children measured at two time points.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: Bayley III (`by3`).
99
#'
@@ -15,7 +15,7 @@
1515
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1616
#'| `cohort` | chr | Cohort name |
1717
#'| `cohortn` | chr | Cohort number |
18-
#'| `id` | int | Child number |
18+
#'| `subjid` | int | Child number |
1919
#'| `agedays` | int | Age (days) |
2020
#'| `sex` | chr | Either `"male"` or `"female"` |
2121
#'| `gagebrth` | int | Gestational age (days) |
@@ -287,7 +287,6 @@
287287
#' Rubio-Codina M. Using the infrastructure of a conditional cash transfer
288288
#' program to deliver a scalable integrated early child development program in
289289
#' Colombia: cluster randomized controlled trial. BMJ. 2014;349.
290-
#' \url{https://www.bmj.com/content/349/bmj.g5785}
291290
#' @examples
292291
#' head(gcdg_col_lt45m)
293292
"gcdg_col_lt45m"

R/gcdg_ecu.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 667 unique children. Cross-sectional.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: Barrera Moncada (`bar`).
99
#'
@@ -15,7 +15,7 @@
1515
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1616
#'| `cohort` | chr | Cohort name |
1717
#'| `cohortn` | chr | Cohort number |
18-
#'| `id` | int | Child number |
18+
#'| `subjid` | int | Child number |
1919
#'| `agedays` | int | Age (days) |
2020
#'| `sex` | chr | Either `"male"` or `"female"` |
2121
#'| `gagebrth` | int | Gestational age (days) |
@@ -44,5 +44,5 @@
4444
#' @references
4545
#' Paxson C, Schady N. Does money matter? The effects of cash transfers on child
4646
#' development in rural Ecuador. Economic development and cultural change.
47-
#' 2010;59:187-229. \url{http://www.jstor.org/stable/10.1086/655458}
47+
#' 2010;59:187-229.
4848
"gcdg_ecu"

R/gcdg_jam_lbw.R

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 226 unique children aged 1.0-2.2 years, two waves.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: Griffiths Scales (`gri`)
99
#'
@@ -15,7 +15,7 @@
1515
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1616
#'| `cohort` | chr | Cohort name |
1717
#'| `cohortn` | chr | Cohort number |
18-
#'| `id` | int | Child number |
18+
#'| `subjid` | int | Child number |
1919
#'| `agedays` | int | Age (days) |
2020
#'| `sex` | chr | Either `"male"` or `"female"` |
2121
#'| `gagebrth` | int | Gestational age (days) |
@@ -208,5 +208,4 @@
208208
#' Walker SP, Chang SM, Powell CA, Grantham-McGregor SM. Psychosocial
209209
#' intervention improves the development of term low-birth-weight infants.
210210
#' The Journal of Nutrition. 2004;134:1417-1423.
211-
#' \url{https://academic.oup.com/jn/article/134/6/1417/4688752}
212211
"gcdg_jam_lbw"

R/gcdg_jam_stunted.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 159 unique children aged 0.75-4.2 years, three waves.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: Griffiths Scales (`gri`)
99
#'
@@ -15,7 +15,7 @@
1515
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1616
#'| `cohort` | chr | Cohort name |
1717
#'| `cohortn` | chr | Cohort number |
18-
#'| `id` | int | Child number |
18+
#'| `subjid` | int | Child number |
1919
#'| `agedays` | int | Age (days) |
2020
#'| `sex` | chr | Either `"male"` or `"female"` |
2121
#'| `gagebrth` | int | Gestational age (days) |
@@ -306,5 +306,5 @@
306306
#' Grantham-McGregor SM, Powell CA, Walker SP, Himes JH. Nutritional
307307
#' supplementation, psychosocial stimulation, and mental development of stunted
308308
#' children: the Jamaican Study. The Lancet. 1991;338:1-5.
309-
#' \url{https://doi.org/10.1016/0140-6736(91)90001-6}
309+
#' \doi{10.1016/0140-6736(91)90001-6}
310310
"gcdg_jam_stunted"

R/gcdg_mdg.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 205 unique children. Cross-sectional.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: McCarthy Scales of Children's Abilities (`mac`), Pegboard (`peg`),
99
#' Stanford Binet Intelligence (`sbi`).
@@ -16,7 +16,7 @@
1616
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1717
#'| `cohort` | chr | Cohort name |
1818
#'| `cohortn` | chr | Cohort number |
19-
#'| `id` | int | Child number |
19+
#'| `subjid` | int | Child number |
2020
#'| `agedays` | int | Age (days) |
2121
#'| `sex` | chr | Either `"male"` or `"female"` |
2222
#'| `gagebrth` | int | Gestational age (days) |
@@ -64,5 +64,5 @@
6464
#' Fernald LCH, Weber A, Galasso E, Ratsifandrihamanana L. Socioeconomic gradients
6565
#' and child development in a very low income population: evidence from Madagascar.
6666
#' Developmental science. 2011;14:832-847.
67-
#' \url{https://doi.org/10.1111/j.1467-7687.2010.01032.x}
67+
#' \doi{10.1111/j.1467-7687.2010.01032.x}
6868
"gcdg_mdg"

R/gcdg_nld_smocc.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' A dataset with developmental scores at the item level for
44
#' 2038 children measured at 16722 visits (rows) between ages 0-2.5 year.
55
#'
6-
#' The combination of `id` and `agedays` identifies each unique visit (row).
6+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
77
#'
88
#' Instruments: Dutch Development Instrument (Van Wiechenschema, version 1983): `ddi`
99
#'
@@ -15,7 +15,7 @@
1515
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1616
#'| `cohort` | chr | Cohort name |
1717
#'| `cohortn` | chr | Cohort number |
18-
#'| `id` | int | Child number |
18+
#'| `subjid` | int | Child number |
1919
#'| `agedays` | int | Age (days) |
2020
#'| `sex` | chr | Either `"male"` or `"female"` |
2121
#'| `gagebrth` | int | Gestational age (days) |

R/gcdg_zaf.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#' 2389 children measured at 4176 visits (rows) between ages 0.3-4.0 year,
55
#' with up to four visits per child.
66
#'
7-
#' The combination of `id` and `agedays` identifies each unique visit (row).
7+
#' The combination of `subjid` and `agedays` identifies each unique visit (row).
88
#'
99
#' Instruments: Bayley I (`by1`), Griffiths (`gri`),
1010
#' South African adapted Griffith (`sgr`), Vineland Social Maturity Scale (`vin`)
@@ -17,7 +17,7 @@
1717
#'| `ctrcd` | chr | Country code (ISO 3166-1 alpha-3) |
1818
#'| `cohort` | chr | Cohort name |
1919
#'| `cohortn` | chr | Cohort number |
20-
#'| `id` | int | Child number |
20+
#'| `subjid` | int | Child number |
2121
#'| `agedays` | int | Age (days) |
2222
#'| `sex` | chr | Either `"male"` or `"female"` |
2323
#'| `gagebrth` | int | Gestational age (days) |
@@ -381,5 +381,5 @@
381381
#' Richter L, Norris S, Pettifor J, Yach D, Cameron N. Cohort profile:
382382
#' Mandela’s children: the 1990 Birth to Twenty study in South Africa.
383383
#' International Journal of Epidemiology. 2007;36:504-511.
384-
#' \url{https://doi.org/10.1093/ije/dym016}
384+
#' \doi{10.1093/ije/dym016}
385385
"gcdg_zaf"

man/gcdg_chn.Rd

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)