Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhroom authored Mar 7, 2021
1 parent b4f8d57 commit 6446f78
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Based on tidyverse, so these functions assume your data is in tidy format.
``data`` - the dataframe that will be used.
``col`` - the column we are measuring change on - variable 'X' in STARS.
``time`` - the column containing time units (e.g. age of a subsample)
``p`` - the largest p-value you want to check regime shifts for. Defaults to p = 0.05.
``p`` - the largest p-value you want to check regime shifts for. Defaults to p = 0.05.
``merge`` - changes the result to be either a regime-shift only table (if FALSE), or an addition to the original table (if TRUE); see below:
Result produced: if merge = FALSE (default), produces a 2-column table of time (the time value for each regime shift) and p (the p-value for each regime shift). If merge = TRUE, returns the original dataset with an extra p-value column, giving the p-value for each time unit - 0 for non-shift years.

Expand Down

0 comments on commit 6446f78

Please sign in to comment.