Skip to content

Function reference organization in pkgdown website #2176

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

Open
olivroy opened this issue Jun 9, 2023 · 3 comments · May be fixed by #2431
Open

Function reference organization in pkgdown website #2176

olivroy opened this issue Jun 9, 2023 · 3 comments · May be fixed by #2431
Labels
feature a feature request or enhancement

Comments

@olivroy
Copy link
Contributor

olivroy commented Jun 9, 2023

Hello,

I am learning the sf package, and browsed through the referene https://r-spatial.github.io/sf/reference/index.html
I find it a bit difficult to browse, and to know which functions fit together (apart from the ones documented together.

Would it be possible to improve _pkgdown.yml? by grouping functions and add small description in the function index

See at https://github.com/tidyverse/dplyr/blob/main/_pkgdown.yml and what the result is https://dplyr.tidyverse.org/reference/index.html

Thanks for the great package

@kadyb
Copy link
Contributor

kadyb commented Jun 12, 2023

BTW: In the cheatsheet the functions are grouped into 6 groups, maybe it will be useful: https://github.com/rstudio/cheatsheets/blob/main/sf.pdf

@edzer
Copy link
Member

edzer commented Jun 26, 2023

PR welcome!

@edzer
Copy link
Member

edzer commented Jun 26, 2023

Another grouping is found in table 1 of https://journal.r-project.org/archive/2018/RJ-2018-009/RJ-2018-009.pdf

@olivroy olivroy changed the title Documentation request Function reference organization in pkgdown website Jun 27, 2023
@edzer edzer added the feature a feature request or enhancement label Sep 15, 2023
@olivroy olivroy linked a pull request Sep 1, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature a feature request or enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants