Pkgdown: Select topics by family

[grabear]

Hello pkgdown!

I'm working on a package and we've started our pkgdowndocumentation. I was wondering if there was a way to utilize the roxygen tag @family to create reference sections in the pkgdown.yml file? If not then this is a feature request! I was envisioning something like:

reference:
- title: Data Visualization
  contents:
  - with_family("Data Visualization")
  # OR
  - family("Data Visualization")

Regardless thanks for all your hard work. pkgdown has been super useful for us and our projects. 😃
Cheers,
@grabear

[jayhesselberth]

Doesn't exist yet but similar to #758 and #760.

[sdhutchins]

And #248.

[grabear]

Thanks for the tip @jayhesselberth. Would you happen to have any knowledge of a workaround for this? Like is there a way for me to get what I want without adding @concept to all of my roxygen docs?

[grabear]

As a side note you could also "Select topics by roxygen tag":

# Just spitballing
reference:
- title: Data Visualization
  contents:
  - family: Data Visualization
- title: Plots
  contents:
  - rdname: plotting-functions

[jayhesselberth]

is there a way for me to get what I want without adding @concept to all of my roxygen docs

I might be missing something but I don't see how to achieve what you want without adding tags in the first place. I.e., even if we had a has_family select helper, you would still have had to categorize your docs with @family tags.

The only other logical organization is to group similar functions by name with common prefixes or suffixes, and we already have select helpers for those (starts_with and ends_with).

[sdhutchins]

is there a way for me to get what I want without adding @concept to all of my roxygen docs

I might be missing something but I don't see how to achieve what you want without adding tags in the first place. I.e., even if we had a has_family select helper, you would still have had to categorize your docs with @family tags.

The only other logical organization is to group similar functions by name with common prefixes or suffixes, and we already have select helpers for those (starts_with and ends_with).

The @family tag is our current implementation in our package.

[grabear]

Yea, just trying to get on the same page. We have already categorized our function docs with the roxygen tag @family. But as you said, there is no means of using this.

I just didn't want to have to go back and add the @concept tag for all of our function docs, but we may end up doing that just for fun.

[jayhesselberth]

I think @family tags are translated to concept in Rd files by the newest roxygen2 (compare your .R. and .Rd files with a family tag).

[sdhutchins]

I think @family tags are translated to concept in Rd files by the newest roxygen2 (compare your .R. and .Rd files with a family tag).

Oh wow, you're correct. Thanks!

That would simply just mean using has_concept("bleh"). :exclamation:

[grabear]

:dizzy_face: Oh wow.... Thank you! I was confused, but now the other Issues make a little more sense...

[jayhesselberth]

Closing this because pkgdown already has the has_concept selector and family tags are converted to concept by newest roxygen2.

[grabear]

Thanks for you quick help and understanding with this Issue!!! @jayhesselberth