Skip to content

Commit 3f68021

Browse files
committed
added short note on dependencies to the readme
1 parent ccf20eb commit 3f68021

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

README.Rmd

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,16 @@ A Toolkit for Year-Quarter, Year-Month and Year-Isoweek Dates
2424
S3 classes and methods to create and work with year-quarter and year-month
2525
vectors. Basic arithmetic operations (such as adding and subtracting) are
2626
supported, as well as formatting and converting to and from standard R
27-
Date types.
27+
Date types. For more info please refer to the
28+
[package vignette](https://cran.r-project.org/web/packages/dint/vignettes/dint.html)
29+
30+
31+
## Dependencies
32+
33+
dint is implemented strictly in base R and will **always stay dependency-free**.
34+
The optional dependencies in Suggests are to enusre interoperability with
35+
these packages if you are already using them.
36+
2837

2938
## Installation
3039

@@ -44,6 +53,8 @@ devtools::install_github("s-fleck/dint")
4453

4554

4655

56+
57+
4758
## Example
4859

4960
```{r example}

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ dint
77

88
A Toolkit for Year-Quarter, Year-Month and Year-Isoweek Dates
99

10-
S3 classes and methods to create and work with year-quarter and year-month vectors. Basic arithmetic operations (such as adding and subtracting) are supported, as well as formatting and converting to and from standard R Date types.
10+
S3 classes and methods to create and work with year-quarter and year-month vectors. Basic arithmetic operations (such as adding and subtracting) are supported, as well as formatting and converting to and from standard R Date types. For more info please refer to the [package vignette](https://cran.r-project.org/web/packages/dint/vignettes/dint.html)
11+
12+
Dependencies
13+
------------
14+
15+
dint is implemented strictly in base R and will **always stay dependency-free**. The optional dependencies in Suggests are to enusre interoperability with these packages if you are already using them.
1116

1217
Installation
1318
------------
@@ -80,7 +85,7 @@ last_of_quarter(q)
8085
first_of_quarter(q)
8186
#> [1] "2014-10-01"
8287
first_of_month(Sys.Date())
83-
#> [1] "2018-09-01"
88+
#> [1] "2018-12-01"
8489
first_of_isoweek(w)
8590
#> [1] "2016-12-26"
8691
last_of_isoweek(w)

0 commit comments

Comments
 (0)