Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

vignette ‘readxl-workflows’ not found #755

Open
jack-davison opened this issue Aug 22, 2024 · 1 comment
Open

vignette ‘readxl-workflows’ not found #755

jack-davison opened this issue Aug 22, 2024 · 1 comment
Labels
documentation good first issue ❤️ good issue for first-time contributors help wanted ❤️ we'd love your help! tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day

Comments

@jack-davison
Copy link

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
Copy link
Member

jennybc commented Sep 9, 2024

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.

@jennybc jennybc added documentation tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day good first issue ❤️ good issue for first-time contributors help wanted ❤️ we'd love your help! labels Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation good first issue ❤️ good issue for first-time contributors help wanted ❤️ we'd love your help! tidy-dev-day 🤓 Tidyverse Developer Day rstd.io/tidy-dev-day
Projects
None yet
Development

No branches or pull requests

2 participants