tobitTrends: Tobit Trends

View source: R/tobitTrends.R

tobitTrendsR Documentation

Tobit Trends

Description

Perform the tobit regression trend test.

Usage

tobitTrends(Stations = "All", Snames = "All", use.logs = TRUE,
  Flow = TRUE, Seasons = TRUE, Covars = NULL, report)

Arguments

Stations

a vector of the station identifiers on which to do the flow adjustment.

Snames

a vector of the response variables on which to do the flow adjustment.

use.logs

log transform the data (and flow) before the trend test?

Flow

logical, include the flow variable? Can also be an expression that includes any transformation of flow.

Seasons

include first-order fourier seasonal terms? Can also be an integer value indicating the order of the terms to include.

Covars

the covariates listed in the regression model.

report

the name of the PDF file that contains a report for each test. The default is to use the name of the project with "_tb" 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.

Note

The trend variable name is .Dectime, which represents the trend in units of per year.


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