From c8b05eb27464700c47a96a0c6aae334022a39ccd Mon Sep 17 00:00:00 2001 From: Arni Magnusson Date: Thu, 27 Apr 2017 23:20:37 +0200 Subject: [PATCH] Release 1.1-0 --- R/flr2taf.R | 5 ++++- R/taf2long.R | 5 ++++- man/flr2taf.Rd | 5 ++++- man/taf2long.Rd | 5 ++++- 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/R/flr2taf.R b/R/flr2taf.R index c9a0787..9c8191f 100644 --- a/R/flr2taf.R +++ b/R/flr2taf.R @@ -1,12 +1,15 @@ #' Convert FLR table to TAF format #' -#' Convert a simple crosstab table from FLR format to TAF format. +#' Convert a simple crosstab table from FLR to TAF format. #' #' @param x a table of class \code{FLQuant}. #' @param na a value that should be converted to NA. #' @param year whether the year should be stored in the first column, instead of #' row names. #' +#' @return +#' A data frame with crosstab data. +#' #' @note #' FLR uses the \code{FLQuant} class to store tables as 6-dimensional arrays, #' while TAF crosstabs are stored as data frames with a year column. diff --git a/R/taf2long.R b/R/taf2long.R index 2a52229..bcdffc5 100644 --- a/R/taf2long.R +++ b/R/taf2long.R @@ -1,12 +1,15 @@ #' Convert TAF table to long format #' -#' Convert a table from TAF crosstab format to a 3-column long format. +#' Convert a TAF crosstab table to long format. #' #' @param x a data frame containing crosstab data. #' @param names a vector of three column names for the resulting data frame. #' @param year whether the input table has year in the first column, instead of #' row names. #' +#' @return +#' A data frame with three columns. +#' #' @note #' TAF stores crosstab tables as data frames with a year column, as seen in #' stock assessment reports. The long format is practical for analysis and diff --git a/man/flr2taf.Rd b/man/flr2taf.Rd index d0e0c19..caf5b98 100644 --- a/man/flr2taf.Rd +++ b/man/flr2taf.Rd @@ -14,8 +14,11 @@ flr2taf(x, na = NULL, year = TRUE) \item{year}{whether the year should be stored in the first column, instead of row names.} } +\value{ +A data frame with crosstab data. +} \description{ -Convert a simple crosstab table from FLR format to TAF format. +Convert a simple crosstab table from FLR to TAF format. } \note{ FLR uses the \code{FLQuant} class to store tables as 6-dimensional arrays, diff --git a/man/taf2long.Rd b/man/taf2long.Rd index f44b91e..56c18ed 100644 --- a/man/taf2long.Rd +++ b/man/taf2long.Rd @@ -14,8 +14,11 @@ taf2long(x, names = c("Year", "Age", "Value"), year = TRUE) \item{year}{whether the input table has year in the first column, instead of row names.} } +\value{ +A data frame with three columns. +} \description{ -Convert a table from TAF crosstab format to a 3-column long format. +Convert a TAF crosstab table to long format. } \note{ TAF stores crosstab tables as data frames with a year column, as seen in