Skip to content

Commit d4feb32

Browse files
committed
docs: add \value sections to DuckDBGRanges man pages; bump to 0.99.1
Document return values (roxygen @return) for the DuckDBGRanges and DuckDBGRangesList class and utility man pages, covering constructors, accessors, replacement, coercion, and range-operation methods. Clears the R CMD BiocCheck missing-\value WARNING.
1 parent 623c467 commit d4feb32

10 files changed

Lines changed: 94 additions & 2 deletions

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: DuckDBGRanges
2-
Version: 0.99.00
3-
Date: 2026-07-18
2+
Version: 0.99.1
3+
Date: 2026-07-22
44
Title: DuckDB-Backed GenomicRanges Implementation
55
Description:
66
Provides DuckDB-backed implementations of GenomicRanges data structures

NEWS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
# DuckDBGRanges 0.99.1
2+
3+
## Documentation
4+
5+
- Added `\value` sections (roxygen `@return`) to the `DuckDBGRanges` and
6+
`DuckDBGRangesList` class and utility man pages, documenting the values
7+
returned by the constructors, accessors, replacement, coercion, and
8+
range-operation methods. Resolves the `R CMD BiocCheck` "missing \value"
9+
WARNING.
10+
111
# DuckDBGRanges 0.9.8
212

313
## Testing and diagnostics

R/DuckDBGRanges-class.R

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,18 @@
190190
#' keycol = "id")
191191
#' gr
192192
#'
193+
#' @return
194+
#' The \code{DuckDBGRanges()} constructor returns a DuckDBGRanges object.
195+
#' Accessors return the requested component of the ranges (for example
196+
#' \code{seqnames()}, \code{start()}, \code{end()}, \code{width()},
197+
#' \code{strand()}, \code{ranges()}, \code{seqinfo()}, \code{length()},
198+
#' \code{names()}, and \code{elementMetadata()}); \code{dbconn()} and
199+
#' \code{tblconn()} return the backing DuckDB connection. Replacement methods
200+
#' (such as \code{seqlengths<-}, \code{genome<-}, and \code{dimtbls<-}) return
201+
#' the updated DuckDBGRanges. Coercion methods return the corresponding
202+
#' in-memory object (for example a \link[GenomicRanges]{GRanges}), subsetting
203+
#' returns a DuckDBGRanges, and the show method returns \code{NULL} invisibly.
204+
#'
193205
#' @aliases DuckDBGRanges-class
194206
#'
195207
#' @aliases dbconn,DuckDBGRanges-method

R/DuckDBGRanges-utils.R

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -337,6 +337,19 @@
337337
#' # Subset by overlaps (uses overlapsAny internally)
338338
#' subset <- subsetByOverlaps(query, subject)
339339
#'
340+
#' @return
341+
#' Overlap methods return a \link[S4Vectors]{Hits} object
342+
#' (\code{findOverlaps()}), an integer vector (\code{countOverlaps()}), a
343+
#' logical vector (\code{overlapsAny()}), or a DuckDBGRanges
344+
#' (\code{subsetByOverlaps()}). Intra-range methods (\code{shift()},
345+
#' \code{narrow()}, \code{resize()}, \code{flank()}, \code{promoters()},
346+
#' \code{terminators()}) return a \link[GenomicRanges]{GRanges}. Inter-range,
347+
#' set-operation, range-restriction, and tiling methods (such as \code{range()}
348+
#' and \code{reduce()}) return a DuckDBGRanges (or DuckDBGRangesList where the
349+
#' result is grouped). Nearest-neighbor, distance, comparison, and ordering
350+
#' methods return the corresponding integer or logical vectors (or a
351+
#' \link[S4Vectors]{Hits}).
352+
#'
340353
#' @aliases findOverlaps,GRanges,DuckDBGRanges-method
341354
#' @aliases findOverlaps,DuckDBGRanges,DuckDBGRanges-method
342355
#' @aliases findOverlaps,DuckDBGRanges,GRanges-method

R/DuckDBGRangesList-class.R

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,18 @@
174174
#' keycol = list(group = c("gr1", "gr2", "gr3", "gr4")))
175175
#' grlist
176176
#'
177+
#' @return
178+
#' The \code{DuckDBGRangesList()} constructor returns a DuckDBGRangesList object.
179+
#' Accessors return the requested component (for example \code{seqnames()},
180+
#' \code{start()}, \code{end()}, \code{width()}, \code{strand()},
181+
#' \code{length()}, \code{names()}, and \code{seqinfo()}); \code{dbconn()} and
182+
#' \code{tblconn()} return the backing DuckDB connection. Replacement methods
183+
#' (such as \code{names<-}, \code{seqlengths<-}, \code{genome<-}, and
184+
#' \code{dimtbls<-}) return the updated DuckDBGRangesList. Coercion methods
185+
#' return the corresponding in-memory object (for example a
186+
#' \link[GenomicRanges]{GRangesList}), and subsetting returns a
187+
#' DuckDBGRangesList.
188+
#'
177189
#' @aliases DuckDBGRangesList-class
178190
#'
179191
#' @aliases updateObject,DuckDBGRangesList-method

R/DuckDBGRangesList-utils.R

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,10 @@
6868
#' # Get range per list element
6969
#' range(grlist)
7070
#'
71+
#' @return
72+
#' \code{range()} returns a DuckDBGRangesList giving the range (minimum start to
73+
#' maximum end) spanned within each list element, per seqname/strand.
74+
#'
7175
#' @aliases
7276
#' range,DuckDBGRangesList-method
7377
#'

man/DuckDBGRanges-class.Rd

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/DuckDBGRanges-utils.Rd

Lines changed: 13 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/DuckDBGRangesList-class.Rd

Lines changed: 12 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/DuckDBGRangesList-utils.Rd

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)