diff --git a/README.md b/README.md index 75f2149..4b3c1c5 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,19 @@ Note: `BBIFile.schema['dtypes']` provides numpy data types for the fields in a b ### Interval output -The actual intervals in a bigWig or bigBed can be retrieved as a pandas dataframe or as an iterator over records as tuples. The pandas output is parsed according to the file's schema. +The actual interval records in a bigWig or bigBed can be retrieved as a pandas dataframe or as an iterator over records as tuples. The pandas output is parsed according to the file's schema. ``` BBIFile.fetch_intervals(chrom, start, end) -> pandas.DataFrame BBIFile.fetch_intervals(chrom, start, end, iterator=True) -> interval iterator ``` +Summary bin records at each zoom level are also accessible. + +``` +BBIFile.fetch_summaries(chrom, start, end, zoom) -> pandas.DataFrame +``` + ### Array output Retrieve quantitative signal as an array. The signal of a bigWig file is obtained from its "value" field. The signal of a bigBed file is obtained from the genomic coverage of its intervals.