Skip to content

Commit

Permalink
Update sunrise docs
Browse files Browse the repository at this point in the history
  • Loading branch information
steffilazerte committed Sep 26, 2023
1 parent d158a98 commit 57381dc
Show file tree
Hide file tree
Showing 5 changed files with 121 additions and 89 deletions.
5 changes: 5 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# motus 6.1.0
* Clean up helper functions `sunRiseSet()` and `timeToSunriset()`
* `sunRiseSet()` now required to run `timeToSunriset()`
* Changed function argument names for clarity

# motus 6.0.1
* Fix bug in `xxxRunsFilter()` functions resulting in the inability to correctly
return the filter id
Expand Down
12 changes: 9 additions & 3 deletions R/aa_common_docs.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# args ------------------
#' Common arguments
#'
#' @param projRecv Numeric project code from motus.org, *or* character receiver
#' @param projRecv Numeric. Project code from motus.org, *or* character receiver
#' serial number.
#' @param src SQLite connection (result of `tagme(XXX)` or
#' `DBI::dbConnect(RSQLite::SQLite(), "XXX.motus")`)
#' @param src SQLite connection. Result of `tagme(XXX)` or
#' `DBI::dbConnect(RSQLite::SQLite(), "XXX.motus")`
#'
#' @param df_src Data frame, SQLite connection, or SQLite table. An SQLite
#' connection would be the result of `tagme(XXX)` or
#' `DBI::dbConnect(RSQLite::SQLite(), "XXX.motus")`; an SQlite table would be
#' the result of `dplyr::tbl(tags, "alltags")`; a data frame could be the
#' result of `dplyr::tbl(tags, "alltags") %>% dplyr::collect()`.
#'
#' @param resume Logical. Resume a download? Otherwise the table is
#' removed and the download is started from the beginning.
Expand Down
12 changes: 9 additions & 3 deletions man/args.Rd

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

93 changes: 59 additions & 34 deletions man/sunRiseSet.Rd

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

88 changes: 39 additions & 49 deletions man/timeToSunriset.Rd

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

0 comments on commit 57381dc

Please sign in to comment.