From 9f4a3b43f0816fe53147ad42dfee7a586aef2f5e Mon Sep 17 00:00:00 2001 From: Mason Garrison Date: Mon, 7 Oct 2024 13:44:43 -0400 Subject: [PATCH] fixed? --- .Rbuildignore | 1 + DESCRIPTION | 2 +- NEWS.md | 4 ++-- R/NlsyLinks-package.R | 6 ++++++ R/nlsy-links.R | 6 ++---- R/subject-details-79-doc.R | 1 - man/NlsyLinks-package.Rd | 34 ++++++++++++++++++++++++++++++++-- man/ReadCsvNlsy79.Rd | 2 +- 8 files changed, 45 insertions(+), 11 deletions(-) create mode 100644 R/NlsyLinks-package.R diff --git a/.Rbuildignore b/.Rbuildignore index e5789b1e..b8f9386c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -35,6 +35,7 @@ ^appveyor\.yml$ ^article/\.vscode$ ^CONDUCT.md$ +^\.lintr$ ^CODE_OF_CONDUCT.md$ ^CODE-OF-CONDUCT.md$ ^code_of_conduct.md$ diff --git a/DESCRIPTION b/DESCRIPTION index 6894de93..1e053991 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -37,7 +37,7 @@ License: GPL LazyData: TRUE VignetteBuilder: knitr Encoding: UTF-8 -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 Roxygen: list(markdown = TRUE) Language: en-US Config/testthat/edition: 2 diff --git a/NEWS.md b/NEWS.md index 250ca462..cd2a8c50 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,7 +1,7 @@ -Version 2.2.2 (2024-09-19) +Version 2.2.2 (2024-10-07) ------------------------------------------------------------------------------ Updates: -* refreshing tests to meet new CRAN guidelines +* Refreshing tests to meet new CRAN guidelines Version 2.2.1 (2023-09-14) diff --git a/R/NlsyLinks-package.R b/R/NlsyLinks-package.R new file mode 100644 index 00000000..a65cf643 --- /dev/null +++ b/R/NlsyLinks-package.R @@ -0,0 +1,6 @@ +#' @keywords internal +"_PACKAGE" + +## usethis namespace: start +## usethis namespace: end +NULL diff --git a/R/nlsy-links.R b/R/nlsy-links.R index 7af99151..109cfe87 100644 --- a/R/nlsy-links.R +++ b/R/nlsy-links.R @@ -3,12 +3,10 @@ #' @description Utilities and kinship information for Behavior Genetics and Developmental research using the NLSY. #' Researchers and grad students interested using the [NLSY](https://www.nlsinfo.org/) for Behavior Genetics and family research, please start with our 2016 article, #' '[*The NLSY Kinship Links: Using the NLSY79 and NLSY-Children Data to Conduct Genetically-Informed and Family-Oriented Research*](https://link.springer.com/article/10.1007/s10519-016-9785-3). -#' -#' @docType package -#' +#'#' #' @name NlsyLinks-package #' -#' @aliases NlsyLinks +#' @aliases NlsyLinks NlsyLinks-package #' #' @note This package considers both Gen1 and Gen2 subjects. "Gen1" refers to #' subjects in the original NLSY79 sample diff --git a/R/subject-details-79-doc.R b/R/subject-details-79-doc.R index e3221bcb..daf0a202 100644 --- a/R/subject-details-79-doc.R +++ b/R/subject-details-79-doc.R @@ -6,7 +6,6 @@ #' #' @description These variables are useful to many types of analyses (not just behavior genetics), and are provided to save users time. #' -#' @docType data #' #' @format A data frame with 24,181 observations on the following 12 #' variables. diff --git a/man/NlsyLinks-package.Rd b/man/NlsyLinks-package.Rd index af42a0ea..4824c136 100644 --- a/man/NlsyLinks-package.Rd +++ b/man/NlsyLinks-package.Rd @@ -1,14 +1,17 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/nlsy-links.R +% Please edit documentation in R/NlsyLinks-package.R, R/nlsy-links.R \docType{package} \name{NlsyLinks-package} \alias{NlsyLinks-package} \alias{NlsyLinks} -\title{Utilities and kinship information for Behavior Genetics and Developmental research using the NLSY.} +\title{NlsyLinks: Utilities and Kinship Information for Research with the NLSY} \description{ +Utilities and kinship information for behavior genetics and developmental research using the National Longitudinal Survey of Youth (NLSY; \url{https://www.nlsinfo.org/}). + Utilities and kinship information for Behavior Genetics and Developmental research using the NLSY. Researchers and grad students interested using the \href{https://www.nlsinfo.org/}{NLSY} for Behavior Genetics and family research, please start with our 2016 article, '\href{https://link.springer.com/article/10.1007/s10519-016-9785-3}{\emph{The NLSY Kinship Links: Using the NLSY79 and NLSY-Children Data to Conduct Genetically-Informed and Family-Oriented Research}}. +#' } \note{ This package considers both Gen1 and Gen2 subjects. "Gen1" refers to @@ -72,8 +75,34 @@ Rodgers, J.L., Rowe, D.C., & Buster, M. (1999). \href{https://pubmed.ncbi.nlm.ni Rodgers, J.L., Rowe, D.C., & Li, C. (1994). \href{https://psycnet.apa.org:443/journals/dev/30/3/374/}{Beyond nature versus nurture: DF analysis of nonshared influences on problem behaviors.} \emph{Developmental Psychology, 30}, 374-384. +} +\seealso{ +Useful links: +\itemize{ + \item \url{https://nlsy-links.github.io/NlsyLinks/} + \item \url{https://github.com/nlsy-links/NlsyLinks} + \item Report bugs at \url{https://github.com/nlsy-links/NlsyLinks/issues} +} + } \author{ +\strong{Maintainer}: S. Mason Garrison \email{garrissm@wfu.edu} (\href{https://orcid.org/0000-0002-4804-6003}{ORCID}) + +Authors: +\itemize{ + \item William Howard Beasley \email{wibeasley@hotmail.com} (\href{https://orcid.org/0000-0002-5613-5006}{ORCID}) +} + +Other contributors: +\itemize{ + \item Joseph Lee Rodgers (\href{https://orcid.org/0000-0002-8615-6713}{ORCID}) [contributor] + \item David Bard [contributor] + \item Michael D. Hunter (\href{https://orcid.org/0000-0002-3651-6709}{ORCID}) [contributor] + \item Patrick O'Keefe (\href{https://orcid.org/0000-0002-5343-0130}{ORCID}) [contributor] + \item Kelly Meredith Williams [contributor] +} + + \href{http://scholar.google.com/citations?user=ffsJTC0AAAAJ}{William Howard Beasley} (Howard Live Oak LLC, Norman) \href{https://www.vanderbilt.edu/psychological_sciences/bio/joe-rodgers}{Joseph Lee Rodgers} (Vanderbilt University, Nashville) @@ -90,4 +119,5 @@ Kelly Meredith Williams (Oklahoma City University, OKC) Maintainer: S. Mason Garrison \href{mailto:garrissm@wfu.edu}{garrissm@wfu.edu} } +\keyword{internal} \keyword{package} diff --git a/man/ReadCsvNlsy79.Rd b/man/ReadCsvNlsy79.Rd index ee70e4f4..c62ffcbd 100644 --- a/man/ReadCsvNlsy79.Rd +++ b/man/ReadCsvNlsy79.Rd @@ -6,7 +6,7 @@ \alias{ReadCsvNlsy79Gen2} \title{Read a CSV file downloaded from the NLS Investigator} \usage{ -ReadCsvNlsy79Gen1(filePath, dsExtract = utils::read.csv(filePath)) +ReadCsvNlsy79Gen1(filePath = NULL, dsExtract = NULL) } \arguments{ \item{filePath}{A path to the CSV file. Remember to use double back-slashes in Windows, or forward-slashes in Windows or Linux.}