Skip to content

Commit

Permalink
Prepare for CRAN release.
Browse files Browse the repository at this point in the history
Bump version to 2.0.0. update metadata in DESCRIPTION, and fix the citation and package descriptions so they pass checks.
  • Loading branch information
mbjones committed Jun 8, 2018
1 parent 16a0fc9 commit 0bbb2f9
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 35 deletions.
35 changes: 20 additions & 15 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
Package: codyn
Title: Community Dynamics Metrics
Version: 1.1.0.9500
Version: 2.0.0
Authors@R: c(person("Lauren", "Hallett", email="[email protected]", role=c("aut")),
person("Meghan L.", "Avolio", email="[email protected]", role=c("aut")),
person("Ian T.", "Carroll", email="[email protected]", role=c("aut")),
person("Sydney K.", "Jones", email="[email protected]", role=c("aut")),
person("A. Andrew M.", "MacDonald", email="[email protected]", role=c("aut")),
person("Dan F. B.", "Flynn", email="[email protected]", role=c("aut")),
person("Peter", "Slaughter", email="[email protected]", role=c("aut")),
person("Julie", "Ripplinger", email="[email protected]", role=c("aut")),
person("Scott L.", "Collins", email="[email protected]", role=c("aut")),
person("Corinna", "Gries", email="[email protected]", role=c("aut")),
person("Matthew B.", "Jones", email="[email protected]", role=c("aut", "cre")),
person("Ian T.", "Carroll", email="[email protected]", role=c("aut")),
person("Meghan L.", "Avolio", email="[email protected]", role=c("aut")))
Date: 2016-04-26
Description: A toolbox of ecological community dynamics metrics that are
explicitly temporal. Functions fall into two categories: temporal diversity
indices and community stability metrics. The diversity indices are temporal
analogs to traditional diversity indices such as richness and rank-abundance
curves. Specifically, functions are provided to calculate species turnover, mean
rank shifts, and lags in community similarity between time points. The community
stability metrics calculate overall stability and patterns of species covariance
and synchrony over time.
person("Matthew B.", "Jones", email="[email protected]", role=c("aut", "cre")))
Date: 2018-06-07
Description: Univariate and multivariate temporal and spatial diversity indices,
rank abundance curves, and community stability metrics. The functions
implement metrics that are either explicitly temporal and include the
option to calculate them over multiple replicates, or spatial and include
the option to calculate them over multiple time points. Functions fall into
five categories: static diversity indices, temporal diversity indices,
spatial diversity indices, rank abundance curves, and community stability
metrics. The diversity indices are temporal and spatial analogs to
traditional diversity indices. Specifically, the package includes functions
to calculate community richness, evenness and diversity at a given point in
space and time. In addition, it contains functions to calculate species
turnover, mean rank shifts, and lags in community similarity between two
time points.
Depends:
R (>= 3.2.0)
Imports:
Expand All @@ -37,8 +42,8 @@ Suggests:
dplyr,
rmarkdown
License: Apache License (== 2.0)
URL: https://github.com/laurenmh/codyn/
BugReports: https://github.com/laurenmh/codyn/issues
URL: https://github.com/NCEAS/codyn/
BugReports: https://github.com/NCEAS/codyn/issues
LazyData: true
VignetteBuilder: knitr
RoxygenNote: 6.0.1
21 changes: 11 additions & 10 deletions R/codyn-package.R
Original file line number Diff line number Diff line change
@@ -1,25 +1,26 @@
#' Community Dynamics Metrics
#' @description Univariate and multivariate temporal and spatial diversity indices, rank abundance curves, and community stability metrics for ecologists.
#' @details The functions in \code{codyn} implement metrics that are either explicitly temporal and include the option to calculate them over multiple replicates or spatial and inlcude the option to calcualte them over multiple time points.
#' @details The functions in \code{codyn} implement metrics that are either explicitly temporal and include the option to calculate them over multiple replicates, or spatial and include the option to calculate them over multiple time points.
#' Functions fall into five categories: static diversity indices, temporal diversity indices, spatial diversity indices, rank abundance curves, and community stability metrics.
#' The diversity indices in \code{codyn} are temporal and spatial analogs to traditional diversity indices.
#' Specifically, \code{codyn} includes functions to calculate community richness, evenness and diveristy at a given point in space and time. In addition, \code{codyn} contains fucntions to calculate species turnover, mean rank shifts, and lags in community similarity between two time points. For the components of rank abundance curves, the shape of the rank abundance curve, species abundances and multivariate metrics of community composition \code{codyn} contains function to calculate these metric either between time points or a single time point between two paired replicates.
#' Specifically, \code{codyn} includes functions to calculate community richness, evenness and diversity at a given point in space and time. In addition, \code{codyn} contains functions to calculate species turnover, mean rank shifts, and lags in community similarity between two time points. For the components of rank abundance curves, the shape of the rank abundance curve, species abundances and multivariate metrics of community composition, \code{codyn} contains functions to calculate these metrics either between time points or a single time point between two paired replicates.
#' The community stability metrics in \code{codyn} calculate overall stability and patterns of species covariance and synchrony over time.
#' Finally, \code{codyn} contains vignettes that describe methods and reproduce figures from published papers to help users contextualize and apply functions to their own data.
#' Work on this package was supported by NSF-ABI grant #1262458 and SESYNC Synthesis Postdoctoral Fellowship to MLA.
#' Work on this package was supported by National Science Foundation grant #1262458 to the National Center for Ecological Analysis and Synthesis (NCEAS), the University of Wisconsin, and the University of New Mexico, and a SESYNC Synthesis Postdoctoral Fellowship to MLA.
#'
#' @author
#' \itemize{
#' \item{Lauren Hallett \email{lauren.m.hallett@@gmail.com}}
#' \item{Meghan L. Avolio \email{[email protected]}}
#' \item{Ian Carroll \email{[email protected]}}
#' \item{Sydney K. Jones \email{syd@@sevilleta.unm.edu}}
#' \item{A. Andrew A. MacDonald \email{aammacdonald@@gmail.com}}
#' \item{Matthew B. Jones \email{jones@@nceas.ucsb.edu}}
#' \item{Dan F. B. Flynn \email{flynn@@fas.harvard.edu}}
#' \item{Peter Slaughter \email{slaughter@@nceas.ucsb.edu}}
#' \item{Corinna Gries \email{cgries@@wisc.edu}}
#' \item{Julie Ripplinger \email{julie.ripplinger@@asu.edu}}
#' \item{Scott L. Collins \email{scollins@@sevilleta.unm.edu}}
#' \item{Meghan L. Avolio \email{meghan.avolio@jhu.edu}}
#' \item{Ian Carroll \email{[email protected]}}
#' \item{Corinna Gries \email{cgries@@wisc.edu}}
#' \item{Matthew B. Jones \email{jones@@nceas.ucsb.edu}}
#' }
#'
#' @docType package
Expand Down Expand Up @@ -103,9 +104,9 @@ NULL
#' \item plot: An integer column of spatial replicates with 18 levels (6-48)
#' \item year: An integer column of sampling time points
#' \item species: A factor column of species sampled
#' \item relative_cover: A numeric column of relatvie cover values
#' \item block: An interger column of dummy blocking variable, grouping treament plots into blocks
#' \item treatment: A factor column of nitorgen and phosphorus treatments applied to the plots
#' \item relative_cover: A numeric column of relative cover values
#' \item block: An integer column of dummy blocking variable, grouping treatment plots into blocks
#' \item treatment: A factor column of nitrogen and phosphorus treatments applied to the plots
#' }
#'
#' @source
Expand Down
6 changes: 3 additions & 3 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ note <- sprintf("R package version %s", meta$Version)
title <- meta$Title
authors <- c(
person("Lauren", "Hallett", email="[email protected]", role=c("aut")),
person("Meghan L.", "Avolio", email="[email protected]", role=c("aut")),
person("Ian T.", "Carroll", email="[email protected]", role=c("aut")),
person("Sydney K.", "Jones", email="[email protected]", role=c("aut")),
person("A. Andrew M.", "MacDonald", email="[email protected]", role=c("aut")),
person("Dan F. B.", "Flynn", email="[email protected]", role=c("aut")),
Expand All @@ -11,13 +13,11 @@ authors <- c(
person("Scott L.", "Collins", email="[email protected]", role=c("aut")),
person("Corinna", "Gries", email="[email protected]", role=c("aut")),
person("Matthew B.", "Jones", email="[email protected]", role=c("aut", "cre")))
person("Meghan L.", "Avolio", email="[email protected]", role=c("aut"))
person("Ian", "Carroll", email="[email protected]", role=c("aut"))

bibentry(bibtype = "Manual",
title = paste0("{codyn}: ", title),
author = authors,
year = year,
note = note,
url = "https://github.com/laurenmh/codyn",
url = "https://github.com/NCEAS/codyn",
doi = "10.5063/F1542KJB")
15 changes: 8 additions & 7 deletions man/codyn.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0bbb2f9

Please sign in to comment.