word_distribution: Compute the distribution of "word"s in a time series.

Description Usage Arguments Details Value

View source: R/pe_code.R

Description

weighted_word_distribution is a wrapper that sets weighted to TRUE

Usage

1
2
3
word_distribution(x_emb, ties.method = "first", weighted = TRUE)

weighted_word_distribution(x_emb, ties.method)

Arguments

x_emb

A time series of real numbers.

ties.method

a character string specifying how ties are treated, see ‘Details’; can be abbreviated.

weighted

whether to weight by the variance in each word

Details

#' Weighted distribution of "word"s in a time series. #' #' @param x A time series of real numbers. #' @param word_length The word length, also known as the permutation order. #' @param tau Time lag (not implemented). #' @param tie_method The method for dealing with tied values; these are the methods used by the rank() #' function of the base package. Use "average" to treat ties as the same value, #' "first" to treat ties as different with first value being treated as larger than second, #' "last" to treat ties as different with last value being treated as larger than second, #' "random" to give ties random rank, #' "noise" to add some noise to the time series to break ties. #' @param noise_amount How much noise to add to the time series; only used for method "noise". #' Random numbers from a uniform distribution with maximum 1 * 10^(-noise_amount-1) and minimum zero. #' @return The word distribution.

Value

a table of the word distribution


weecology/MATSS-forecasting documentation built on Nov. 28, 2020, 10:19 a.m.