R/dataset-docs.R

In MikkoVihtakari/sclero: Measure Growth Patterns and Align Sampling Spots in Photographs

#' Coordinates of sample spots and growth lines along a bivalve mollusk shell section
#'
#' @docType data
#' @keywords datasets
#' @name shellspots
#' @usage data(shellspots)
#' @format \code{IJDATA} object. A list containing ImageJ ROI information about sample spots and growth lines along a bivalve mollusk shell section. The information is acquired by running "shellspots.zip" dataset through the \code{\link{read.ijdata}} function (see Examples). The list contains following data frames / vectors:
#' \itemize{
#'   \item spots.x. A data frame containing x-coordinates for sample spots with each sample spot sequence in its own column.
#'   \item spots.y. A data frame containing y-coordinates for sample spots.
#'   \item gbs.x. A data frame containing x-coordinates for growth lines with each growth line in its own column.
#'   \item gbs.y. A data frame containing y-coordinates for growth lines
#'   \item main.x. A data frame containing x-coordinates for the measurement axis 
#'   \item main.y. A data frame containing y-coordinates for the measurement axis 
#'   \item sample.name. A vector containing the sample name
#'   \item scaling.factor. A numeric value defining the scale of photograph in pixels / \code{unit}.
#'   \item unit. A charater vector defining the unit of measurements.
#' }
NULL

#' Coordinates of sample spots together with spot size information and growth lines along a bivalve mollusk shell section
#'
#' @docType data
#' @keywords datasets
#' @name shellsizes
#' @usage data(shellsizes)
#' @format \code{rawDist} object. A list containing \link[spatstat]{spatstat} point and line patterns as well as owin objects defining the sample spot, growth line, distance axis and sample spot size coordinates.
NULL

#' Barium to calcium ratios for sample spots in shellspots dataset
#'
#' @docType data
#' @keywords datasets
#' @name barium
#' @usage data(barium)
#' @format A dataframe containing Ba/Ca information for \link{shellspots}. The object is ready for \code{\link{assign.size}} function.
NULL