gdalcubes/man/collection_formats.Rd
2019-02-07 15:58:17 +01:00

27 lines
1.1 KiB
R

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/image_collection.R
\name{collection_formats}
\alias{collection_formats}
\title{List predefined image collection formats}
\usage{
collection_formats(print = TRUE)
}
\arguments{
\item{print}{logical; should available formats and their descriptions be printed nicely, defaults to TRUE}
}
\value{
data.frame with columns \code{name} and \code{description} where the former describes the unique identifier that can be used in \code{create_image_collection} and the
latter gives a brief description of the format.
}
\description{
gdalcubes comes with some predefined collection formats e.g. to scan Sentinel 2 data. This function lists available formats including brief descriptions.
}
\details{
Image collection formats define how individual files / GDAL datasets relate to an image collection, i.e.,
which bands they contain, to which image they belong, and how to derive aquisition date/time.
They are described as a set of regular expressions in a JSON file and used by gdalcubes to extract this information
from the paths and/or filenames.
}
\examples{
collection_formats()
}