tidyverse / readxl

Read excel files (.xls and .xlsx) into R 🖇
https://readxl.tidyverse.org
Other
729 stars 194 forks source link

vignette ‘readxl-workflows’ not found #755

Open jack-davison opened 2 months ago

jack-davison commented 2 months ago

The documentation for excel_sheets() reads:

The list of sheet names is especially useful when you want to iterate over all of the sheets in a workbook. The vignette("readxl-workflows") article provides several worked examples of this, showing how to combine readxl with other packages in the tidyverse, such as purrr, or with base R functions like lapply().

However, this vignette isn't exported by {readxl}:

Vignettes in package ‘readxl’:

cell-and-column-types                           Cell and Column Types (source, html)
sheet-geometry                                  Sheet Geometry (source, html)

I can see it's on the {pkgdown} website, but it's not a vignette available locally, which threw me off trying to open it using vignette() like the docs suggest!

jennybc commented 2 months ago

This is a think-o. The workflows article can't be a vignette, because it uses packages that readxl does not depend on (nor will it ever). So such a reference should be an actual URL to the rendered article on the pkgdown website.

If you (or anyone else) wants to make a PR to fix, that would be welcome.