R/birds_documentation.R

In flying: Simulation of Bird Flight Range

#' Sample 28 birds
#'
#' Preset birds data, extracted from Flight program. Fat mass percentage
#' generated randomly where zero.
#'
#' @format A data frame with 28 observations and 5 variables not counting the
#'         name.
#'
#' \describe{
#'    \item{Scientific.name}{Name of bird species}
#'    \item{Empty.mass}{Body mass in Kg. Includes fuel. All-up mass with crop
#'    empty. Not to be confused with lean mass.}
#'    \item{Wing.span}{Length of wings spread out in metres}
#'    \item{Fat.mass}{Mass of fat that is consumable as fuel in Kg}
#'    \item{Order}{Order of the spicies (passerine vs non-passerine)}
#'    \item{Wing.area}{Area of both wing projected on a flat surface in metres
#'    squared}
#'    \item{Muscle.mass}{Mass in Kg. of flight muscles}
#'
#' }
#'
"birds"