Skip to content

Commit

Permalink
use ".r" instead of "comment" as chunk engine
Browse files Browse the repository at this point in the history
  • Loading branch information
@etiennebacher
etiennebacher committed Jul 1, 2024
1 parent 403443b commit 4ad8950
Showing 1 changed file with 77 additions and 77 deletions.
154 changes: 77 additions & 77 deletions vignettes/userguide.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ options(rmarkdown.html_vignette.check_title = FALSE)
```


````{comment}
```{.r}
These functions/methods are either missing, broken, or Vincent can't figure out how to use them.
* `Series_shift`
Expand All @@ -33,7 +33,7 @@ Requires new Polars version:
* `df$sample()`
* `df$describe()`
````
```

[The Polars User Guide](https://pola-rs.github.io/polars-book/user-guide/) is a detailed tutorial about the Polars DataFrame library. Its goal is to introduce you to Polars by going through examples and comparing it to other solutions. Some design choices are introduced there. The guide also introduces you to optimal usage of Polars. The Polars User Guide is available at this link:

Expand Down Expand Up @@ -271,82 +271,82 @@ dataset$
collect()
```

<!-- ```{r} -->
<!-- compute_age = function() 2021 - pl$col("birthday")$dt$year() -->

<!-- avg_birthday = function(gender) { -->
<!-- compute_age()$filter(pl$col("gender") == gender)$mean()$alias(sprintf("avg %s birthday", gender)) -->
<!-- } -->

<!-- q = ( -->
<!-- dataset$lazy()$ -->
<!-- group_by("state")$ -->
<!-- agg( -->
<!-- avg_birthday("M"), -->
<!-- avg_birthday("F"), -->
<!-- (pl$col("gender") == "M")$sum()$alias("# male"), -->
<!-- (pl$col("gender") == "F")$sum()$alias("# female") -->
<!-- )$ -->
<!-- limit(5) -->
<!-- ) -->
<!-- q$collect() -->

<!-- # -->
<!-- # get_person <- function() pl$col("first_name") + pl$lit(" ") + pl$col("last_name") -->
<!-- # q = ( -->
<!-- # dataset$lazy() -->
<!-- # $sort("birthday", descending=True) -->
<!-- # $group_by(["state"]) -->
<!-- # $agg( -->
<!-- # [ -->
<!-- # get_person()$first()$alias("youngest"), -->
<!-- # get_person()$last()$alias("oldest"), -->
<!-- # ] -->
<!-- # ) -->
<!-- # $limit(5) -->
<!-- # ) -->
<!-- # q$collect() -->
<!-- # -->
<!-- # get_person <- function() pl$col("first_name") + pl$lit(" ") + pl$col("last_name") -->
<!-- # q = ( -->
<!-- # dataset$lazy() -->
<!-- # $sort("birthday", descending=True) -->
<!-- # $group_by(["state"]) -->
<!-- # $agg( -->
<!-- # [ -->
<!-- # get_person()$first()$alias("youngest"), -->
<!-- # get_person()$last()$alias("oldest"), -->
<!-- # get_person()$sort()$first()$alias("alphabetical_first"), -->
<!-- # ] -->
<!-- # ) -->
<!-- # $limit(5) -->
<!-- # ) -->
<!-- # q$collect() -->
<!-- # -->
<!-- # q = ( -->
<!-- # dataset$lazy() -->
<!-- # $sort("birthday", descending=True) -->
<!-- # $group_by(["state"]) -->
<!-- # $agg( -->
<!-- # [ -->
<!-- # get_person()$first()$alias("youngest"), -->
<!-- # get_person()$last()$alias("oldest"), -->
<!-- # get_person()$sort()$first()$alias("alphabetical_first"), -->
<!-- # pl$col("gender")$sort_by("first_name")$first()$alias("gender"), -->
<!-- # ] -->
<!-- # ) -->
<!-- # $sort("state") -->
<!-- # $limit(5) -->
<!-- # ) -->
<!-- # q$collect() -->
<!-- ``` -->
```{.r}
compute_age = function() 2021 - pl$col("birthday")$dt$year()
avg_birthday = function(gender) {
compute_age()$filter(pl$col("gender") == gender)$mean()$alias(sprintf("avg %s birthday", gender))
}
q = (
dataset$lazy()$
group_by("state")$
agg(
avg_birthday("M"),
avg_birthday("F"),
(pl$col("gender") == "M")$sum()$alias("# male"),
(pl$col("gender") == "F")$sum()$alias("# female")
)$
limit(5)
)
q$collect()
#
# get_person <- function() pl$col("first_name") + pl$lit(" ") + pl$col("last_name")
# q = (
# dataset$lazy()
# $sort("birthday", descending=True)
# $group_by(["state"])
# $agg(
# [
# get_person()$first()$alias("youngest"),
# get_person()$last()$alias("oldest"),
# ]
# )
# $limit(5)
# )
# q$collect()
#
# get_person <- function() pl$col("first_name") + pl$lit(" ") + pl$col("last_name")
# q = (
# dataset$lazy()
# $sort("birthday", descending=True)
# $group_by(["state"])
# $agg(
# [
# get_person()$first()$alias("youngest"),
# get_person()$last()$alias("oldest"),
# get_person()$sort()$first()$alias("alphabetical_first"),
# ]
# )
# $limit(5)
# )
# q$collect()
#
# q = (
# dataset$lazy()
# $sort("birthday", descending=True)
# $group_by(["state"])
# $agg(
# [
# get_person()$first()$alias("youngest"),
# get_person()$last()$alias("oldest"),
# get_person()$sort()$first()$alias("alphabetical_first"),
# pl$col("gender")$sort_by("first_name")$first()$alias("gender"),
# ]
# )
# $sort("state")
# $limit(5)
# )
# q$collect()
```



## Folds


```{comment}
```{.r}
df = pl$DataFrame(
"a" = c(1, 2, 3),
"b" = c(10, 20, 30)
Expand Down Expand Up @@ -396,7 +396,7 @@ df = pl$read_csv(
)
```

```{comment}
```{.r}
df$select(
"Type 1",
"Type 2",
Expand All @@ -407,7 +407,7 @@ df$select(
```


```{comment}
```{.r}
filtered = df$
filter(pl$col("Type 2") == "Psychic")$
select(c("Name", "Type 1", "Speed"))
Expand Down Expand Up @@ -449,7 +449,7 @@ df$sort("Type 1")$select(

# List context and row wise computations

```{comment}
```{.r}
grades = pl$DataFrame(
"student" = c("bas", "laura", "tim", "jenny"),
"arithmetic" = c(10, 5, 6, 8),
Expand Down Expand Up @@ -477,7 +477,7 @@ grades$with_columns(

# Custom functions

```{comment}
```{.r}
df = pl$DataFrame(
"keys" = c("a", "a", "b"),
"values" = c(10, 7, 1)
Expand Down Expand Up @@ -621,7 +621,7 @@ df$group_by("fruits")$
```


```{comment}
```{.r}
# We can explode the list column "cars" to a new row for each element in the list
df$
# sort("cars")$
Expand Down

0 comments on commit 4ad8950

Please sign in to comment.