From 1e009feca80e0e14755798af8d56753b338eac8d Mon Sep 17 00:00:00 2001 From: njlyon0 Date: Tue, 12 Mar 2024 09:03:02 -0700 Subject: [PATCH] Adding credit for Miguel Leon for the `solar_day_info` function concept --- DESCRIPTION | 27 +++++++++++++++------------ R/solar_day_info.R | 2 +- README.Rmd | 2 +- README.md | 3 ++- man/ltertools-package.Rd | 1 + man/solar_day_info.Rd | 2 +- 6 files changed, 21 insertions(+), 16 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 8329bf7..58eebef 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -3,22 +3,25 @@ Type: Package Title: Tools Developed by the Long Term Ecological Research Community Version: 1.0.0.900 Authors@R: c( - person(given = "Nicholas", - family = "Lyon", - role = c("aut", "cre"), - email = "lyon@nceas.ucsb.edu", - comment = c(ORCID = "0000-0003-3905-1078", + person(given = "Nicholas", family = "Lyon", + role = c("aut", "cre"), + email = "lyon@nceas.ucsb.edu", + comment = c(ORCID = "0000-0003-3905-1078", Website = "https://njlyon0.github.io/")), person(given = "Angel", family = "Chen", - email = "anchen@nceas.ucsb.edu", - comment = c(ORCID = "0000-0003-3515-6710", - Website = "angelchen7.github.io"), - role = c("aut")), + role = c("aut"), + email = "anchen@nceas.ucsb.edu", + comment = c(ORCID = "0000-0003-3515-6710", + Website = "angelchen7.github.io")), + person(given = "Miguel C.", family = "Leon", + role = c("ctb"), + comment = c(ORCID = "0000-0003-1260-9449", + Website = "https://luquillo.lter.network/")), person(family = "National Science Foundation", - role = "fnd", - comment = "NSF 1929393, 09/01/2019 - 08/31/2024"), + role = "fnd", + comment = "NSF 1929393, 09/01/2019 - 08/31/2024"), person(family = "University of California, Santa Barbara", - role = "cph") ) + role = "cph") ) Maintainer: Nicholas Lyon Description: Set of the data science tools created by various members of the Long Term Ecological Research (LTER) community. These functions were initially written largely diff --git a/R/solar_day_info.R b/R/solar_day_info.R index de8c3e6..f26a867 100644 --- a/R/solar_day_info.R +++ b/R/solar_day_info.R @@ -1,6 +1,6 @@ #' @title Identify Solar Day Information #' -#' @description For all days between the specified start and end date, identify the time of sunrise, sunset, and solar noon (in UTC) as well as the day length. +#' @description For all days between the specified start and end date, identify the time of sunrise, sunset, and solar noon (in UTC) as well as the day length. The idea for this function was contributed by [Miguel C. Leon](https://luquillo.lter.network/) and a Python equivalent lives in the Luquillo site's [LUQ-general-utils GitHub repository](https://github.com/LUQ-LTER/LUQ-general-utils). #' #' @param lat (numeric) latitude coordinate for which to find day length #' @param lon (numeric) longitude coordinate for which to find day length diff --git a/README.Rmd b/README.Rmd index 1bc0ac9..58a796d 100644 --- a/README.Rmd +++ b/README.Rmd @@ -45,7 +45,7 @@ As functions are added to the package they will be briefly summarized below and - **`read`** -- Reads in all files of specified types in a particular folder and stores them as elements in a list. List element names are the respective file names. Currently supports CSV, TXT, XLS, and XLSX file formats -- **`solar_day_info`** -- Identify sunrise, sunset, solar noon, and day length for all dates within a user-specified range at particular coordinates +- **`solar_day_info`** -- Identify sunrise, sunset, solar noon, and day length for all dates within a user-specified range at particular coordinates. Function concept contributed by [Miguel C. Leon](https://luquillo.lter.network/) - **`cv`** -- Calculate coefficient of variation (CV) from a vector of numbers diff --git a/README.md b/README.md index 2ead7f4..f0d359a 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,8 @@ below and attributed to their author(s) - **`solar_day_info`** – Identify sunrise, sunset, solar noon, and day length for all dates within a user-specified range at particular - coordinates + coordinates. Function concept contributed by [Miguel C. + Leon](https://luquillo.lter.network/) - **`cv`** – Calculate coefficient of variation (CV) from a vector of numbers diff --git a/man/ltertools-package.Rd b/man/ltertools-package.Rd index 3b42cee..2baa1ae 100644 --- a/man/ltertools-package.Rd +++ b/man/ltertools-package.Rd @@ -26,6 +26,7 @@ Authors: Other contributors: \itemize{ + \item Miguel C. Leon (\href{https://orcid.org/0000-0003-1260-9449}{ORCID}) (https://luquillo.lter.network/) [contributor] \item National Science Foundation (NSF 1929393, 09/01/2019 - 08/31/2024) [funder] \item University of California, Santa Barbara [copyright holder] } diff --git a/man/solar_day_info.Rd b/man/solar_day_info.Rd index 628a139..03c5f6d 100644 --- a/man/solar_day_info.Rd +++ b/man/solar_day_info.Rd @@ -27,7 +27,7 @@ solar_day_info( (dataframe) table of 6 columns and a number of rows equal to the number of days between the specified start and end dates (inclusive). Columns contain: (1) date, (2) sunrise time, (3) sunset time, (4) solar noon, (5) day length, and (6) time zone of columns 2 to 4. } \description{ -For all days between the specified start and end date, identify the time of sunrise, sunset, and solar noon (in UTC) as well as the day length. +For all days between the specified start and end date, identify the time of sunrise, sunset, and solar noon (in UTC) as well as the day length. The idea for this function was contributed by \href{https://luquillo.lter.network/}{Miguel C. Leon} and a Python equivalent lives in the Luquillo site's \href{https://github.com/LUQ-LTER/LUQ-general-utils}{LUQ-general-utils GitHub repository}. } \examples{ # Identify day information in Santa Barbara (California) for one week