Skip to content

Commit

Permalink
Remove references to lubridate in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wkmor1 committed Jan 25, 2024
1 parent 03a66bf commit 07311dd
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 61 deletions.
31 changes: 15 additions & 16 deletions R/filters.R
Original file line number Diff line number Diff line change
Expand Up @@ -138,21 +138,20 @@
#' Filters related to time of record include:
#'
#' - `date_range_ymd` Dates.
#' An \link[lubridate:Interval-class]{Interval} object or a vector of one to
#' two \link[base:Dates]{Date} objects (begin and end dates) or objects that
#' are coercible to the \link[base:Dates]{Date} class by
#' \link[lubridate]{as_date}. When supplying dates as strings, the day or
#' month-and-day can be omitted (e.g.,`"2001-04"` or `"2001"`). Note however,
#' that when omitting day, only "`-`" is allowed to separate year and month,
#' and months must be in two-digit/leading zero form. If the begin or end
#' dates are partial date strings they will be interpreted as the first or
#' last day of the month or year (e.g., `c(2001, 2003)` is equivalent to
#' A vector of one to two \link[base:Dates]{Date} objects (begin and end
#' dates) or objects that are coercible to the \link[base:Dates]{Date}. When
#' supplying dates as strings, the day or month-and-day can be omitted (e.g.,
#' `"2001-04"` or `"2001"`). Note however, that when omitting day, only "`-`"
#' is allowed to separate year and month, and months must be in
#' two-digit/leading zero form. If the begin or end dates are partial date
#' strings they will be interpreted as the first or last day of the month or
#' year (e.g., `c(2001, 2003)` is equivalent to
#' `c("2001-01-01", "2003-12-12")`). If a single date is supplied as a partial
#' date string then all records that fall within that month or year will be
#' returned (e.g., `c("2001-01")` is equivalent to
#' `c("2001-01-01", "2001-01-31")`). Use empty strings for the begin or end
#' date to specify open-ended date ranges (e.g., `c("2000-01-01", "")` for
#' all dates from the turn of the century).
#' date to specify open-ended date ranges (e.g., `c("2000-01-01", "")` for all
#' dates from the turn of the century).
#' - `date_range_ym` Dates.
#' As above, but days (if supplied) will be ignored.
#' - `date_range_d` Integer vector.
Expand All @@ -165,11 +164,11 @@
#' - `{first|last}_import_date_{min|max}` Date.
#' Filter by date record was imported/modified. Either a
#' \link[base:Dates]{Date} object or object that is coercible to the
#' \link[base:Dates]{Date} class by \link[lubridate]{as_date}, or the number
#' of seconds since 1970-01-01 00:00.00 UTC (the so-called UNIX epoch). Note
#' that this means that specifying a year, such as 2019, without a month and
#' day will be interpreted as 2019 seconds after midnight on Jan 1, 1970 and
#' not the year 2019.
#' \link[base:Dates]{Date} class, or the number of seconds since 1970-01-01
#' 00:00.00 UTC (the so-called UNIX epoch). Note that this means that
#' specifying a year, such as 2019, without a month and day will be
#' interpreted as 2019 seconds after midnight on Jan 1, 1970 and not the year
#' 2019.
#'
#' @section Quality:
#' Filters related to quality of record:
Expand Down
3 changes: 1 addition & 2 deletions docs/articles/v05_filtering.html

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

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ articles:
v03_selecting_variables: v03_selecting_variables.html
v04_metadata: v04_metadata.html
v05_filtering: v05_filtering.html
last_built: 2024-01-23T06:36Z
last_built: 2024-01-25T08:09Z

31 changes: 15 additions & 16 deletions docs/reference/filters.html

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

2 changes: 1 addition & 1 deletion docs/search.json

Large diffs are not rendered by default.

4 changes: 1 addition & 3 deletions inst/vign/v05_filtering.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ FinBIF. The date filters can be a single year, month or date,
```{details date-filter}
finbif_occurrence(filter = list(date_range_ym = c("2019-12")))
```
, or for record events, a range as a character vector or an
[Interval](https://lubridate.tidyverse.org/reference/Interval-class.html)
object.
, or for record events, a range as a character vector.
```{details date-range-filter}
finbif_occurrence(
filter = list(date_range_ymd = c("2019-06-01", "2019-12-31"))
Expand Down
4 changes: 1 addition & 3 deletions inst/vign/v05_filtering.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@ finbif_occurrence(filter = list(date_range_ym = c("2019-12")))

</details>
<br>
, or for record events, a range as a character vector or an
[Interval](https://lubridate.tidyverse.org/reference/Interval-class.html)
object.
, or for record events, a range as a character vector.

```r
finbif_occurrence(
Expand Down
31 changes: 15 additions & 16 deletions man/filters.Rd

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

4 changes: 1 addition & 3 deletions vignettes/v05_filtering.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,7 @@ finbif_occurrence(filter = list(date_range_ym = c("2019-12")))

</details>
<br>
, or for record events, a range as a character vector or an
[Interval](https://lubridate.tidyverse.org/reference/Interval-class.html)
object.
, or for record events, a range as a character vector.

```r
finbif_occurrence(
Expand Down

0 comments on commit 07311dd

Please sign in to comment.