% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/read.r
\name{bigwig_info}
\alias{bigwig_info}
\title{Report header metadata and summary statistics for a bigWig file.}
\usage{
bigwig_info(bwfile)
}
\arguments{
\item{bwfile}{path or URL for a bigWig 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_levels}, \code{n_chroms},
\code{n_bases_covered}, \code{min}, \code{max}, \code{mean}, and \code{std}.
}
\description{
Reads the bigWig header without loading any intervals. The summary
statistics (\code{min}, \code{max}, \code{mean}, \code{std}) are the file-level values stored in
the header and computed over all covered bases.
}
\examples{
bw <- system.file("extdata", "test.bw", package = "cpp11bigwig")

bigwig_info(bw)

}
\seealso{
\code{\link[=read_bigwig]{read_bigwig()}}, \code{\link[=bigbed_info]{bigbed_info()}}
}
