Skip to content

Commit

Permalink
fixed vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
alexhroom committed Oct 17, 2023
1 parent 8d0f09e commit c7c6c38
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions vignettes/STARSmanual.ltx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
\usepackage{natbib}
\usepackage{graphicx}
\usepackage{caption}
\usepackage{subcaption}

\title{\texttt{rshift} STARS manual - regime shift analysis for paleoecological data\\v2.2.2}

Expand Down Expand Up @@ -95,7 +96,7 @@ The other 3 variables are optional:
If merge = TRUE, returns the original dataset with an extra RSI column, giving the RSI for each time unit - 0 for non-shift years.
\end{itemize}
So, as an example, we will reproduce the data from the Rodionov paper. Rodionov uses the Pacific Decadal Oscillation (PDO) as his dataset, a measure of climate
variability over the Pacific Ocean (see \citet{mantua2002pacific} for more details). This is available in the \texttt{rshift} package as the dataset \texttt{January_PDO}.
variability over the Pacific Ocean (see \citet{mantua2002pacific} for more details). This is available in the \texttt{rshift} package as the dataset \texttt{January\_PDO}.
To load it, ensure that `rshift' has been imported into your R session (with \texttt{library(rshift)}) and then run \texttt{data(January\_PDO)} to
load the data into your session. We then can run the STARS algorithm in the simplest way with the following line of code:

Expand All @@ -118,16 +119,16 @@ RSI_graph(RSI_data, "DCA1", "Age", "RSI"))
It takes the data, variable column and chronology like before, but you must also specify the name of the column with RSI values in (which \texttt{Rodionov()} automatically creates as 'RSI'). \newpage
\begin{figure}[!h]
\centering
\begin{subfigure}[b]{0.3\textwidth}
\begin{subfigure}[b]{\textwidth}
\centering
\includegraphics[width=\textwidth]{rshift_PDO_plot.png}
\end{subfigure}
\vfill
\begin{subfigure}[b]{0.3\textwidth}
\begin{subfigure}[b]{\textwidth}
\centering
\includegraphics[width=\textwidth]{Rodionov_graph.png}
\end{subfigure}
\caption{}
\caption{The RSI plot generated by \texttt{rshift}, and the plot of the same data from \citet{rodionov2004sequential}.}
\end{figure}
\newpage
\section{Evaluating use of STARS}
Expand Down

0 comments on commit c7c6c38

Please sign in to comment.