network: Specify Network Smoother in Formulae

In alastairrushworth/smnet: Smoothing for Stream Network Data

Description

This function specifies all of the information required to smooth parameters over the segments of a stream network using an adjacency matrix, and a vector of flow weights.

Usage

network(adjacency = NULL, weight = "autoShreve", fixed.df = NULL)

Arguments

adjacency	A sparse adjacency matrix of class spam that describes the flow connectedness of the stream network. adjacency is typically obtained from a call to get_adjacency
weight	A character string indicating the column name of a numeric vector of flow weights contained in the data.object that has been passed to smnet. Defaults to "autoShreve" which automatically constructs a weighting based on Shreve order, useful if data does not include an appropriate weight. For more information on choosing appropriate weight inputs from a given data set, see show_weights.
fixed.df	Positive scalar indicating a fixed number of degrees of freedom to allocate to the stream network component, overriding the criterion minimisation for this component. Under the default setting, NULL, the degrees of freedom are chosen automatically.

Value

A list combining the processed input components above. For internal use within smnet.

• adjacency: Sparse adjacency matrix

• weight: Numeric vector of flow weights

• netID: Integer identifying network of interest

Author(s)

Alastair Rushworth

alastairrushworth/smnet documentation built on Nov. 13, 2020, 10:27 p.m.