You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: R/plot_catchcurve.R
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
#' @inheritParams plot_growth
5
5
#' @param time Split analysis by time? If \code{NULL}, all data are assumed to stem from one time point. Using a character argument giving the name of a time column splits the analysis by unique values in that column and produces a faceted plot.
6
6
#' @param age.range Defines the age range to be used for Z estimation. If \code{NULL}, all ages are used. If a numeric vector of length 2, the first number defines the minimum age to include and the last number the maximum age. It is also possible to use differing ranges by sex when \code{split.by.sex = TRUE}: use a named list of length two with names referring to \code{female.sex} and \code{male.sex}. Provide a numeric vector of length 2 to each element (first number defining the minimum age to include and the last number the maximum age). See Examples.
7
-
#' @details Calculates and plots the basic log-linearized catch curve to estimate instantaneous mortality. See e.g. \href{https://www.fishbase.se/manual/english/FishBaseThe_LENGTH_WEIGHT_Table.htm}{Ogle (2013)}.
7
+
#' @details Calculates and plots the basic log-linearized catch curve to estimate instantaneous mortality. See e.g. Ogle (2016) \emph{Introductory Fisheries Analyses with R}, Chapter 11.
8
8
#' @author Mikko Vihtakari // Institute of Marine Research.
#' @title Plot age-length relationships and growth curves
51
+
#' @description Fits and plots a von Bertalanffy, Gompertz, or Logistic growth curve to age-length data. Returns the plot, a text summary, and estimated parameters.
2
52
#' @param length Character argument giving the name of the length column in \code{dt}
3
53
#' @param age Character argument giving the name of the age column in \code{dt}
4
54
#' @param growth.model Integer defining the growth model. 1 = von Bertalanffy, 2 = Gompertz, 3 = Logistic.
@@ -10,13 +60,13 @@
10
60
#' @param return_model Logical indicating whether the growth models should be returned together with other output.
11
61
#' @param return_data Logical indicating whether the data used to make the growth models should be returned together with other output.
12
62
#' @param show.Linf Logical indicating whether Linf values should be shown as dashed vertical lines.
13
-
#' @param base_size Base size parameter for ggplot. See \link[ggplot2]{ggtheme}.
63
+
#' @param base_size Base size parameter for ggplot. See \link[ggplot2]{theme}.
14
64
#' @details Uses the \code{fishmethods::growth} function to calculate the growth curves. Zero group length can be forced to the growth functions using the \code{force.zero.group.*} parameters.
15
-
#' @return A list containing the \code{plot}, \code{text} for Rmarkdown and Shiny applications, and estimated parameters (\code{params}).
65
+
#' @return A list containing the \code{plot}, \code{text} for Rmarkdown and Shiny applications, estimated parameters (\code{params}), the raw \code{model} object (if \code{return_model = TRUE}), and the prepared \code{data} (if \code{return_data = TRUE}).
16
66
#' @author Mikko Vihtakari // Institute of Marine Research.
0 commit comments