Skip to content

Commit 9b4e41a

Browse files
committed
docs: Add installation instructions for the development version in README
1 parent cde6724 commit 9b4e41a

2 files changed

Lines changed: 25 additions & 11 deletions

File tree

README.Rmd

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,14 @@ Sys.setenv(NOT_CRAN = "true")
136136
install.packages("tidypolars", repos = c("https://community.r-multiverse.org", 'https://cloud.r-project.org'))
137137
```
138138

139+
The development version contains the latest improvements and bug fixes:
140+
141+
```{r eval=FALSE}
142+
# install.packages("remotes")
143+
remotes::install_github("etiennebacher/tidypolars")
144+
```
145+
146+
139147

140148
## Contributing
141149

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ thorough, representative benchmarks about `polars`, take a look at
5050

5151
``` r
5252
library(collapse, warn.conflicts = FALSE)
53-
#> collapse 2.0.16, see ?`collapse-package` or ?`collapse-documentation`
53+
#> collapse 2.1.1, see ?`collapse-package` or ?`collapse-documentation`
5454
library(dplyr, warn.conflicts = FALSE)
5555
library(dtplyr)
5656
library(polars)
@@ -114,17 +114,16 @@ bench::mark(
114114
check = FALSE,
115115
iterations = 40
116116
)
117-
#> Warning: Some expressions had a GC in every iteration;
118-
#> so filtering is disabled.
117+
#> Warning: Some expressions had a GC in every iteration; so filtering is
118+
#> disabled.
119119
#> # A tibble: 5 × 6
120-
#> expression min median `itr/sec` mem_alloc
121-
#> <bch:expr> <bch:tm> <bch:tm> <dbl> <bch:byt>
122-
#> 1 polars 277.93ms 304.59ms 3.17 1.99MB
123-
#> 2 tidypolars 286.78ms 362.65ms 2.35 1.2MB
124-
#> 3 dplyr 3.16s 3.63s 0.257 1.79GB
125-
#> 4 dtplyr 1.58s 1.92s 0.461 1.72GB
126-
#> 5 collapse 702.79ms 948.19ms 0.987 745.96MB
127-
#> # ℹ 1 more variable: `gc/sec` <dbl>
120+
#> expression min median `itr/sec` mem_alloc `gc/sec`
121+
#> <bch:expr> <bch:tm> <bch:tm> <dbl> <bch:byt> <dbl>
122+
#> 1 polars 91.75ms 101.63ms 8.67 2.03MB 0.217
123+
#> 2 tidypolars 128.61ms 269.19ms 3.37 1.49MB 1.01
124+
#> 3 dplyr 3.21s 4.42s 0.235 1.79GB 0.611
125+
#> 4 dtplyr 916.43ms 964.62ms 1.02 1.72GB 2.25
126+
#> 5 collapse 372.23ms 454.87ms 2.13 745.96MB 2.19
128127

129128
# NOTE: do NOT take the "mem_alloc" results into account.
130129
# `bench::mark()` doesn't report the accurate memory usage for packages calling
@@ -144,6 +143,13 @@ Sys.setenv(NOT_CRAN = "true")
144143
install.packages("tidypolars", repos = c("https://community.r-multiverse.org", 'https://cloud.r-project.org'))
145144
```
146145

146+
The development version contains the latest improvements and bug fixes:
147+
148+
``` r
149+
# install.packages("remotes")
150+
remotes::install_github("etiennebacher/tidypolars")
151+
```
152+
147153
## Contributing
148154

149155
Did you find some bugs or some errors in the documentation? Do you want

0 commit comments

Comments
 (0)