SKTrends: Seasonal Kendall Trends

View source: R/SKTrends.R

SKTrendsR Documentation

Seasonal Kendall Trends

Description

Perform the seasonal Kendall trend test.

Usage

SKTrends(Stations = "All", Snames = "All", use.logs = TRUE,
  max.cens = 5, nseas = NULL, report)

Arguments

Stations

a vector of the the station identifiers on which to do the trend test.

Snames

a vector of the response variables on which to do the trend test.

use.logs

logical, if TRUE, then log transform the data before the trend test, otherwise no log transform is used. Applies only to uncensored seasonal Kendall test—the data for the censored seasonal Kendall test is never log-transformed.

max.cens

the maximum percent censoring permitted for the uncensored seasonal Kendall test. If the percentage of censoring exceeds this value, then the censored seasonal Kendall test is performed. Set to a negative value to force the censored seasonal Kendall test for all Stations and Snames.

nseas

the number of seasons to use for all of the tests. If NULL (default), then use the selected number of seasons defined in setProj. Applies only when the type of analysis is "seasonal."

report

the base name of the PDF file that contains a report for each test; the suffix ".pdf" should not be inlcuded. The default is to use the name of the project with "_sk" appended. If the PDF file exists, then it is not overwritten, but the name is appended with a sequence of numbers until one that is valid is created.

Value

The name of the report file.


USGS-R/restrend documentation built on Oct. 11, 2022, 6:10 a.m.