Skip to content

Commit

Permalink
fix warnings -- docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chenyangkang committed Jan 19, 2025
1 parent 2d88ef1 commit de8451d
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 16 deletions.
9 changes: 6 additions & 3 deletions R/RouteDataFunction.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
#' @description Custom print method for `Routes` objects, summarizing their contents and metadata.
#'
#' @param x A `Routes` object to print.
#'
#' @param ... Additional arguments passed to `print.data.frame`.
#'
#' @return Invisibly returns the input `routes` object.
#' @method print Routes
#' @export
Expand Down Expand Up @@ -59,7 +60,8 @@ print.Routes <- function(x, ...){
#' and BirdFlow-specific attributes.
#'
#' @param x A `BirdFlowRoutes` object to print.
#'
#' @param ... Additional arguments passed to `print.data.frame`.
#'
#' @return Invisibly returns the input `birdflow_routes` object.
#' @method print BirdFlowRoutes
#' @export
Expand Down Expand Up @@ -115,7 +117,8 @@ print.BirdFlowRoutes <- function(x, ...){
#' and metadata, including temporal and spatial ranges.
#'
#' @param x A `BirdFlowIntervals` object to print.
#'
#' @param ... Additional arguments passed to `print.data.frame`.
#'
#' @return Invisibly returns the input `birdflow_intervals` object.
#' @method print BirdFlowIntervals
#' @export
Expand Down
2 changes: 1 addition & 1 deletion R/is_between.R
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ if (FALSE) {
#' @param radius A point is considered between two locations if it is within
#' `radius` meters (along a great circle) of the great circle line between the
#' locations. `radius` defaults to half the cell size (`mean(res(bf))/2`).
#' @param n_direction The number of (equally spaced) directional bins to
#' @param n_directions The number of (equally spaced) directional bins to
#' classify bearings into. Currently only `1` is supported.
#' @param skip_unconnected If `TRUE` then only connections that exist in `bf`
#' will be evaluated, and between matrix will erroneously indicate that
Expand Down
4 changes: 0 additions & 4 deletions R/weight_between.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,6 @@ if (FALSE) {
#' at a time. A smaller
#' `batch_size` will conserve memory at a slight performance cost. The number
#' of batches will be less than or equal to `n_active(bf)^2 / batch_size`.
#' @param check_radius If `TRUE` an error will be thrown if the radius
#' is not between the resolution and 1/4 the resolution of `bf`. Outside of
#' that range the algorithm is likely to yield distorted results.
#' `mean(res(bf)) / 2` is the default, and recommended radius.
#' @return A list with:
#' \item{between}{An array with dimensions representing the
#' "from" location, the "to" location, and the `points`. Cells are weights and
Expand Down
6 changes: 3 additions & 3 deletions man/is_between.Rd

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

2 changes: 2 additions & 0 deletions man/print.BirdFlowIntervals.Rd

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

2 changes: 2 additions & 0 deletions man/print.BirdFlowRoutes.Rd

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

2 changes: 2 additions & 0 deletions man/print.Routes.Rd

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

5 changes: 0 additions & 5 deletions man/weight_between.Rd

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

0 comments on commit de8451d

Please sign in to comment.