Skip to content

Commit

Permalink
doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
js2264 committed Sep 12, 2023
1 parent 6f4842d commit 72466e9
Show file tree
Hide file tree
Showing 9 changed files with 47 additions and 37 deletions.
4 changes: 4 additions & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,13 @@ export(anchors2)
export(arrange)
export(as_ginteractions)
export(count)
export(count_overlaps)
export(count_overlaps_directed)
export(end1)
export(end2)
export(filter)
export(filter_by_non_overlaps)
export(filter_by_overlaps)
export(find_overlaps)
export(find_overlaps_directed)
export(flank_downstream)
Expand Down
8 changes: 4 additions & 4 deletions R/count-overlaps.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' When using `count_overlaps()` with a `PinnedGInteractions` object,
#' only the pinned anchors are used to check for overlap with `y`.
#' This is equivalent to specifying `use.region="both"` in
#' \code{\href{https://bioconductor.org/packages/release/bioc/vignettes/InteractionSet/inst/doc/interactions.html#27_Overlap_methods}{InteractionSet::countOverlaps()}}.
#' `InteractionSet::findOverlaps()`.
#'
#' @param x A (Pinned)GInteractions object
#' @param y A GRanges object
Expand Down Expand Up @@ -81,7 +81,7 @@ count_overlaps.PinnedGInteractions <- function(
#' @rdname ginteractions-count-overlaps
#' @export
count_overlaps.GInteractions <- function(
x, y, maxgap = -1L, minoverlap = 0L, suffix = c(".x", ".y")
x, y, maxgap = -1L, minoverlap = 0L
) {

InteractionSet::countOverlaps(
Expand All @@ -99,7 +99,7 @@ count_overlaps.GInteractions <- function(
#' @rdname ginteractions-count-overlaps
#' @export
count_overlaps_directed.PinnedGInteractions <- function(
x, y, maxgap = -1L, minoverlap = 0L, suffix = c(".x", ".y")
x, y, maxgap = -1L, minoverlap = 0L
) {

InteractionSet::countOverlaps(
Expand All @@ -121,7 +121,7 @@ count_overlaps_directed.PinnedGInteractions <- function(
#' @rdname ginteractions-count-overlaps
#' @export
count_overlaps_directed.GInteractions <- function(
x, y, maxgap = -1L, minoverlap = 0L, suffix = c(".x", ".y")
x, y, maxgap = -1L, minoverlap = 0L
) {

InteractionSet::countOverlaps(
Expand Down
6 changes: 3 additions & 3 deletions R/filter-overlaps.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' When using `filter_by_overlaps()` with a `PinnedGInteractions` object,
#' only the pinned anchors are used to check for overlap with `y`.
#' This is equivalent to specifying `use.region="both"` in
#' \code{\href{https://bioconductor.org/packages/release/bioc/vignettes/InteractionSet/inst/doc/interactions.html#27_Overlap_methods}{InteractionSet::countOverlaps()}}.
#' `InteractionSet::findOverlaps()`.
#'
#' @param x A (Pinned)GInteractions object
#' @param y A GRanges object
Expand Down Expand Up @@ -81,7 +81,7 @@ filter_by_overlaps.PinnedGInteractions <- function(
#' @rdname ginteractions-filter-overlaps
#' @export
filter_by_overlaps.GInteractions <- function(
x, y, maxgap = -1L, minoverlap = 0L, suffix = c(".x", ".y")
x, y, maxgap = -1L, minoverlap = 0L
) {

IRanges::subsetByOverlaps(
Expand Down Expand Up @@ -122,7 +122,7 @@ filter_by_non_overlaps.PinnedGInteractions <- function(
#' @rdname ginteractions-filter-overlaps
#' @export
filter_by_non_overlaps.GInteractions <- function(
x, y, maxgap = -1L, minoverlap = 0L, suffix = c(".x", ".y")
x, y, maxgap = -1L, minoverlap = 0L
) {

IRanges::subsetByOverlaps(
Expand Down
2 changes: 1 addition & 1 deletion R/find-overlaps.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
#' When using `find_overlaps()` with a `PinnedGInteractions` object,
#' only the pinned anchors are used to check for overlap with `y`.
#' This is equivalent to specifying `use.region="both"` in
#' \code{\href{https://bioconductor.org/packages/release/bioc/vignettes/InteractionSet/inst/doc/interactions.html#27_Overlap_methods}{InteractionSet::findOverlaps()}}.
#' `InteractionSet::findOverlaps()`.
#'
#' @param x A (Pinned)GInteractions object
#' @param y A GRanges object
Expand Down
20 changes: 20 additions & 0 deletions R/reexports-plyranges.R
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,23 @@ plyranges::find_overlaps
#' @importFrom plyranges find_overlaps_directed
#' @export
plyranges::find_overlaps_directed

#' @rdname reexports
#' @importFrom plyranges count_overlaps
#' @export
plyranges::count_overlaps

#' @rdname reexports
#' @importFrom plyranges count_overlaps_directed
#' @export
plyranges::count_overlaps_directed

#' @rdname reexports
#' @importFrom plyranges filter_by_overlaps
#' @export
plyranges::filter_by_overlaps

#' @rdname reexports
#' @importFrom plyranges filter_by_non_overlaps
#' @export
plyranges::filter_by_non_overlaps
24 changes: 6 additions & 18 deletions man/ginteractions-count-overlaps.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 3 additions & 9 deletions man/ginteractions-filter-overlaps.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/ginteractions-find-overlaps.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion man/reexports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 72466e9

Please sign in to comment.