Missing docs for S3 methods?

[hadley]

I think it would be useful to document mutate(), filter() etc methods so its obvious that duckplyr supports them. This would also be a good place to document any differences in behaviour.

[krlmlr]

DoD:

• Understand and perhaps avoid collisions that occur for ?mutate as soon as duckplyr is loaded
• Draft for 2-3 verbs, reviewed
• Documentation for verbs similarly to ?dbplyr::mutate.tbl_lazy
• Fallback conditions are documented
• Most important differences in behavior are documented
• Add list of verbs that are not implemented

[maelle]

https://github.com/r-dbi/DBI/blob/50b82902541fe1f22e8eeb43f658dd69845e1bb8/man-roxygen/methods.R

https://github.com/r-dbi/DBI/blob/50b82902541fe1f22e8eeb43f658dd69845e1bb8/R/methods_as_rd.R#L1

[maelle]

methods("mutate") works but methods("select") suffers from the conflict.

[maelle]

https://github.com/tidyverse/dplyr/blob/fb25640fa1eb74746a7a74a06090045106e5d20f/R/doc-methods.R#L45

[krlmlr]

I don't follow:

options(conflicts.policy = list(warn = FALSE))
library(dplyr)

dplyr:::methods_generic("mutate")
#> # A tibble: 1 × 7
#>   generic class      package topic visible source              isS4 
#>   <chr>   <chr>      <chr>   <chr> <lgl>   <chr>               <lgl>
#> 1 mutate  data.frame dplyr   <NA>  FALSE   registered S3method FALSE
dplyr:::methods_generic("select")
#> # A tibble: 1 × 7
#>   generic class      package topic visible source              isS4 
#>   <chr>   <chr>      <chr>   <chr> <lgl>   <chr>               <lgl>
#> 1 select  data.frame dplyr   <NA>  FALSE   registered S3method FALSE

library(dbplyr)
library(dtplyr)
library(dm)

dplyr:::methods_generic("mutate")
#> # A tibble: 5 × 7
#>   generic class       package topic                    visible source      isS4 
#>   <chr>   <chr>       <chr>   <chr>                    <lgl>   <chr>       <lgl>
#> 1 mutate  data.frame  dplyr   <NA>                     FALSE   registered… FALSE
#> 2 mutate  dm          dm      <NA>                     FALSE   registered… FALSE
#> 3 mutate  dm_zoomed   dm      dplyr_table_manipulation FALSE   registered… FALSE
#> 4 mutate  dtplyr_step dtplyr  mutate.dtplyr_step       FALSE   registered… FALSE
#> 5 mutate  tbl_lazy    dbplyr  mutate.tbl_lazy          FALSE   registered… FALSE
dplyr:::methods_generic("select")
#> # A tibble: 5 × 7
#>   generic class       package topic                    visible source      isS4 
#>   <chr>   <chr>       <chr>   <chr>                    <lgl>   <chr>       <lgl>
#> 1 select  data.frame  dplyr   <NA>                     FALSE   registered… FALSE
#> 2 select  dm          dm      <NA>                     FALSE   registered… FALSE
#> 3 select  dm_zoomed   dm      dplyr_table_manipulation FALSE   registered… FALSE
#> 4 select  dtplyr_step dtplyr  select.dtplyr_step       FALSE   registered… FALSE
#> 5 select  tbl_lazy    dbplyr  select.tbl_lazy          FALSE   registered… FALSE

^{Created on 2024-11-21 with reprex v2.1.1}