Skip to content

Commit

Permalink
Remove deprecated run_sea func
Browse files Browse the repository at this point in the history
  • Loading branch information
brews committed Jul 10, 2019
1 parent 76048a9 commit 957af5d
Show file tree
Hide file tree
Showing 4 changed files with 1 addition and 55 deletions.
1 change: 0 additions & 1 deletion NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ export(plot_demograph)
export(plot_intervals_dist)
export(plot_sealags)
export(read_fhx)
export(run_sea)
export(sample_depth)
export(sea)
export(series_mean_interval)
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Changes in this release:

*
* Removed deprecated `run_sea()`. Be sure to use `sea()` now.


# burnr v0.4.0
Expand Down
22 changes: 0 additions & 22 deletions R/sea.R
Original file line number Diff line number Diff line change
@@ -1,25 +1,3 @@
#' Perform superposed epoch analysis.
#'
#' @param x A data.frame climate reconstruction or tree-ring series with row names as years.
#' @param key A vector of event years for superposed epoch, such as fire years, or an fhx object
#' with a single \code{series} as produced by \code{composite}
#' @param years_before The number of lag years prior to the event year
#' @param years_after The number of lag years following the event year
#' @param key_period Logical. Constrains the time series to the time period of key events within the range
#' of the x climate series. False uses the entire climate series, ignoring the period of key events.
#' time series
#' @param n_iter The number of iterations for bootstrap resampling
#'
#' @details This function, 'run_sea', is a development version of burnr::sea and has been depreciated. Please use \code{sea}.
#' @export
run_sea <- function(x, key, years_before=6, years_after=4,
key_period = TRUE, n_iter=1000) {
.Deprecated('sea')
sea(x, key, nbefore=years_before, nafter=years_after,
event_range=key_period, n_iter=n_iter)
}


#' Perform superposed epoch analysis.
#'
#' @param x A data.frame climate reconstruction or tree-ring series with row names as years.
Expand Down
31 changes: 0 additions & 31 deletions man/run_sea.Rd

This file was deleted.

0 comments on commit 957af5d

Please sign in to comment.