% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/read.r
\name{bigbed_info}
\alias{bigbed_info}
\title{Report header metadata for a bigBed file.}
\usage{
bigbed_info(bbfile)
}
\arguments{
\item{bbfile}{path or URL for a bigBed file. Remote files
(\verb{http://}, \verb{https://}, \verb{ftp://}) are supported when the package was
installed with libcurl available.}
}
\value{
A named list with elements \code{version}, \code{n_chroms}, \code{field_count},
\code{defined_field_count}, \code{n_bases_covered}, and \code{autosql} (the embedded
autoSql schema string, or \code{""} when the file has none).
}
\description{
Reads the bigBed header without loading any intervals. This is useful for
identifying the BED variant a file holds before reading it: a genuine BED12
has \code{defined_field_count == 12}, whereas a \code{bed9+3} file (9 standard BED
columns plus 3 custom fields) has \code{defined_field_count == 9} and
\code{field_count == 12}.
}
\examples{
bb <- system.file("extdata", "test.bb", package = "cpp11bigwig")

info <- bigbed_info(bb)
info$defined_field_count

}
\seealso{
\code{\link[=read_bigbed]{read_bigbed()}}, \code{\link[=bigwig_info]{bigwig_info()}}
}
