length_calc: Help calculate how many periods you need for desired index...

Description Usage Arguments Value Examples

View source: R/helper_functions.R

Description

The FEWS function truncates the results by removing the first window. This function helps you determine the amount of periods required to produced the desired FEWS index output length

Usage

1
length_calc(index_start, window_length, verbose = TRUE)

Arguments

index_start

how many periods back do you want the index to start (numeric)

window_length

window length used

Value

The numeric representation of how many periods you will need in your input dataset to calculate an index of length 'index_start' with a window length of 'window_length'

Examples

1
2
3
4
5
6
7
8
#I want to calculate an index from June to June for a monthly index with a window length
#of 27 months

#index_start will be 13 as this is the number of periods for June to June

length_calc(index_start = 13, window_length = 27)

#Total periods required:  39

MjStansfi/GEKS_package documentation built on May 12, 2021, 8:44 p.m.