-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
92 lines (63 loc) · 7.06 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# NlsyLinks
<!-- badges: start -->
[](https://www.repostatus.org/#active)
[](https://cran.r-project.org/package=NlsyLinks)
[](https://cran.r-project.org/package=NlsyLinks)</br>
[](https://github.com/nlsy-links/NlsyLinks/actions)
<!-- badges: end -->
NlsyLinks is a free downloadable R package to facilitate Behavior Genetic and Family Studies research using the NLSY samples (the National Longitudinal Survey of Youth). These samples are based on a cross-generational longitudinal nationally representative sample of over 30,000 participants followed for up to 35 years. There are almost 50,000 pairwise kinship links.
Get started at [here](https://www.nlsinfo.org/) the NLSY and [here](https://nlsy-links.github.io/NlsyLinks//) for the NlsyLinks package.
Installing
--------------------------
The *release* version of `NlsyLinks` can be installed from [CRAN](https://cran.r-project.org/package=NlsyLinks).
```r
install.packages("NlsyLinks")
```
The latest *development* version of `NlsyLinks` can be installed from [GitHub](https://github.com/nlsy-links/NlsyLinks/) after installing the `remotes` package.
```r
install.packages("remotes")
remotes::install_github(repo="nlsy-links/NlsyLinks")
```
Obtaining the Links
--------------------------
There are roughly three versions of the links:
1. The *release* versions are bundled in the `NlsyLinks` package and updated once or twice a year during development.
1. The *pre-release* versions are downloadable from our [team's website](https://nlsy-links.github.io/NlsyLinks/) and updated several times a month during development. Formats include R, SAS, and plain-text CSV.
1. The *development* versions are downloadable from our [determination repo](https://github.com/nlsy-links/nlsy-links-determination-2017) updated several times a day during development.
Locations for Help and Development
--------------------------
This repository contains the code used in the [NlsyLinks](https://cran.r-project.org/package=NlsyLinks) R package. For additional information about the package and using it in NLSY research, please see <https://nlsy-links.github.io/NlsyLinks/>.
[This GitHub repository](https://github.com/nlsy-links/nlsy-links-determination-2017) is our primary way of managing, tracking, and build-checking versions of the source code. (We're no longer using our [R-Forge site](https://r-forge.r-project.org/projects/nlsylinks/).) The stable releases (intended for most researchers) is available on the package's [CRAN site](https://cran.r-project.org/package=NlsyLinks).
We recently moved the forums to <https://groups.google.com/forum/#!forum/nlsy-links>. Previous conversations are available at our old [R-Forge](https://r-forge.r-project.org/forum/?group_id=1330) and [Disqus](https://disqus.com/home/forum/nlsylinks/) sites.
Publication
--------------------------
Please see [research-publications](https://nlsy-links.github.io/NlsyLinks/articles/publications.html) for a list of the 70+ publications arising from the kinship links. An overview is available at:
Joseph Lee Rodgers, William H. Beasley, David E. Bard, Kelly M. Meredith, Michael D. Hunter, Amber B. Johnson, Maury Buster, Chengchang Li, Kim O. May, S. Mason Garrison, Warren B. Miller, Edwin van den Oord, and David C. Rowe (2016). *Behavior Genetics, 46*. [https://doi.org/10.1007/s10519-016-9785-3](https://doi.org/10.1007/s10519-016-9785-3).
>The National Longitudinal Survey of Youth datasets (NLSY79; NLSY-Children/Young Adults; NLSY97) have extensive family pedigree information contained within them. These data sources are based on probability sampling, a longitudinal design, and a cross-generational and within-family data structure, with hundreds of phenotypes relevant to behavior genetic (BG) researchers, as well as to other developmental and family researchers. These datasets provide a unique and powerful source of information for BG researchers. But much of the information required for biometrical modeling has been hidden, and has required substantial programming effort to uncover—until recently. Our research team has spent over 20 years developing kinship links to genetically inform biometrical modeling. In the most recent release of kinship links from two of the NLSY datasets, the direct kinship indicators included in the 2006 surveys allowed successful and unambiguous linking of over 94 % of the potential pairs. In this paper, we provide details for research teams interested in using the NLSY data portfolio to conduct BG (and other family-oriented) research.
Thanks to Funders
--------------------------
The current work on the NLSY Kinship links has been supported by NIH Grant R01-HD065865 ([Joe Rodgers](https://www.vanderbilt.edu/psychological_sciences/bio/joe-rodgers), PI).
Build Status and Package Characteristics
--------------------------
| [Branch](https://github.com/nlsy-links/NlsyLinks) | [GitHub Actions](https://github.com/nlsy-links/NlsyLinks/actions) | [Codecov](https://app.codecov.io/gh/nlsy-links/NlsyLinks) |
| :----- | :---------------------------: | :-------: |
| [Master](https://github.com/nlsy-links/NlsyLinks/tree/master) | [](https://github.com/nlsy-links/NlsyLinks/actions) | [](https://app.codecov.io/gh/nlsy-links/NlsyLinks) |
| [Dev](https://github.com/nlsy-links/NlsyLinks/tree/dev) | [](https://github.com/nlsy-links/NlsyLinks/actions) | [](https://app.codecov.io/gh/nlsy-links/NlsyLinks/branch/dev) |
| | *Ubuntu Latest* | *Test Coverage* |
| [CRAN](https://cran.r-project.org/) | [Version](https://cran.r-project.org/package=NlsyLinks) | [Rate](https://cranlogs.r-pkg.org:443/) | [Zenodo](https://zenodo.org/search?ln=en&p=nlsylinks) |
| :---- | :----: | :----: | :----: |
| [Latest](https://cran.r-project.org/package=NlsyLinks) | [](https://cran.r-project.org/package=NlsyLinks) |  | [](http://dx.doi.org/10.5281/zenodo.49941) |
| | *Latest CRAN version* | *CRAN Downloads* | *Independently-hosted Archive* |