R/satellites_documentation.R

In nfrontero20/satellites: What the Package Does (One Line, Title Case)

#' "satellites"
#'
#' A data set containing information on the 2670 satellites orbiting
#' Earth as of March 31, 2020.  The data in this package was obtained
#' from the Union of Concerned Scientists (UCS) Satellite Database
#' 4/1/2020 release.
#'
#' @format A dataframe with 2670 elements
#' \describe{
#'   \item{official_name}{Official name}
#'   \item{registered}{Country registered with the UN as responsible}
#'   \item{user_affiliation}{Affilitation of the primary users}
#'   \item{purpose}{Discipline of the primary users}
#'   \item{orbit_class}{Class of the orbit}
#'   \item{perigee}{Perigee (km)}
#'   \item{apogee}{Apogee (km)}
#'   \item{eccentricity}{Eccentricity)}
#'   \item{period}{Time required to complete one full orbit of Earth (minutes)}
#'   \item{launch_date}{Date of satellite launch}
#' }
#' @source \url{https://www.ucsusa.org/resources/satellite-database}
"satellites"