-
Notifications
You must be signed in to change notification settings - Fork 23
/
get_results_timeseries.Rd
55 lines (55 loc) · 1.6 KB
/
get_results_timeseries.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/get-results.r
\name{get_results_timeseries}
\alias{get_results_timeseries}
\title{Return the time series information from an iteration}
\usage{
get_results_timeseries(report.file)
}
\arguments{
\item{report.file}{An \code{\link[r4ss]{SS_output}} list for a model
(operating model or estimation model).}
}
\value{
A data frame with the following columns:
\itemize{
\item year
\item Area
\item Seas
\item Bio_smry
\item SpawnBio
\item Recruit_0
\item retainB_\link{0-9}+
\item retainN_\link{0-9}+
\item deadB_\link{0-9}+
\item deadN_\link{0-9}+
\item F_\link{0-9}+
\item SPRratio
\item rec_dev
\item raw_rec_dev
}
}
\description{
Extract and return time series from an \code{\link[r4ss:SS_output]{r4ss::SS_output()}} list, that is
read in from the estimation method of a single iteration. The main time
series information is included but no information about the uncertainty of
those measurements is available. See the derived quantities for uncertainty.
}
\details{
Information about both season and area are included in the data frame. For
values that have no associated season or area, i.e., are summary values over
all areas and seasons, the values are repeated for each area/season
combination within a given year. For example, the recruitment deviation is
for all areas and is thus repeated in each row across areas for a given year.
}
\seealso{
Other get-results:
\code{\link{get_results_all}()},
\code{\link{get_results_derived}()},
\code{\link{get_results_scalar}()},
\code{\link{get_results_scenario}()}
}
\author{
Cole Monnahan
}
\concept{get-results}