diff --git a/NEWS.md b/NEWS.md index 2f34fba..5143891 100644 --- a/NEWS.md +++ b/NEWS.md @@ -24,7 +24,7 @@ Changes in this minor release: * Change to `sea` objects, added `event_years`. -* Added function `percent_scarred()` for calculating timeseries of number trees recording, scarred, and the percentage. +* Added function `percent_scarred()` for calculating time series of number trees recording, scarred, and the percentage. * Update to `sample_depth()` to account for single-series fhx objects @@ -69,7 +69,7 @@ Changes in this minor release: * Added `year_range()` to give (min, max) years for an `fhx` object. -* Updated `composite()` to include a filter for number of events. This necesitates fixes in other functions (e.g. `plot_demograph()`). +* Updated `composite()` to include a filter for number of events. This necessitates fixes in other functions (e.g. `plot_demograph()`). * Added `summary()` function for fhx and intervals objects. @@ -160,7 +160,7 @@ Changes in this patch: * In `get_ggplot()` the `legend` argument is now `plot_legend` to avoid clash with common functions. -* In `fhx$rings` and all functions, `type` arugment is now `rec_type` to avoid clash with `type` function. `rec_type` is short for "record_type". +* In `fhx$rings` and all functions, `type` argument is now `rec_type` to avoid clash with `type` function. `rec_type` is short for "record_type". * Can now read FHX files with a single series (closes bug #43). diff --git a/R/sea.R b/R/sea.R index 63ef625..b7ee25b 100644 --- a/R/sea.R +++ b/R/sea.R @@ -34,8 +34,8 @@ run_sea <- function(x, key, years_before=6, years_after=4, #' #' @details Superposed epoch analysis (SEA) helps to evaluate fire-climate #' relationships in studies of tree-ring fire history. It works by compositing the values of -#' an annual timeseries or climate reconstruction for the fire years provided (\code{key}) and both positive and -#' negative lag years. Bootstrap resampling of the timeseries is performed to evaluate the statistical +#' an annual time series or climate reconstruction for the fire years provided (\code{key}) and both positive and +#' negative lag years. Bootstrap resampling of the time series is performed to evaluate the statistical #' significance of each year's mean value. Users interpret the departure of the actual event year #' means from the simulated event year means. Note that there is no rescaling of the climate time series 'x'. #' @@ -97,7 +97,7 @@ sea <- function(x, event, nbefore=6, nafter=4, event_range=TRUE, n_iter=1000) { # set up rnames <- as.numeric(rownames(x)) if (all(as.character(seq(length(rnames))) == rnames)) { - warning("`x` arg for `sea()` could be missing rownames - be sure that timeseries years are rownames") + warning("`x` arg for `sea()` could be missing rownames - be sure that time series years are rownames") } event.cut <- rnames[rnames %in% event] if (length(event.cut) <= 0) { diff --git a/man/sea.Rd b/man/sea.Rd index e632b8f..947272f 100644 --- a/man/sea.Rd +++ b/man/sea.Rd @@ -34,8 +34,8 @@ Perform superposed epoch analysis. \details{ Superposed epoch analysis (SEA) helps to evaluate fire-climate relationships in studies of tree-ring fire history. It works by compositing the values of -an annual timeseries or climate reconstruction for the fire years provided (\code{key}) and both positive and -negative lag years. Bootstrap resampling of the timeseries is performed to evaluate the statistical +an annual time series or climate reconstruction for the fire years provided (\code{key}) and both positive and +negative lag years. Bootstrap resampling of the time series is performed to evaluate the statistical significance of each year's mean value. Users interpret the departure of the actual event year means from the simulated event year means. Note that there is no rescaling of the climate time series 'x'.