Skip to contents

Pick documentation matching some concepts.

Source: R/reference_concept.R, R/reference_package.R
reference_concept.Rd

Create a data.frame with documentation metadata of one or more packages. If you develop a universe, such as the tidyverse or tidymodels, pkgdoc helps you to easily create a universe-wide reference for the pkgdown website of your meta-package.

Usage

reference_concept(
  x,
  url_template = NULL,
  url = NULL,
  packages = NULL,
  strip_s3class = TRUE
)

Arguments

x

A character vector giving concepts or package names to match.

url_template

Character. A template to generate links to documentation based on the column names of the output – typically package and topic, e.g. "https://maurolepore.github.io/{package}/reference/{topic}.html" (glue::glue() syntax).

url

Character vector of length-1 giving a base url, e.g. "https://maurolepore.github.io/".

packages

A character vector with the names of packages to limit the search, or NULL to serach in all known libraries.

strip_s3class

TRUE removes the class component of S3 methods.

Value

A dataframe.

Examples

reference_concept("Datasets available by data()")
#> # A tibble: 391 × 5
#>    topic         alias                            title          concept package
#>    <chr>         <chr>                            <chr>          <chr>   <chr>  
#>  1 .BITS         .BITS, bit_init, bit_done        Initializing … Datase… bit    
#>  2 .BITS         .BITS, bit_init, bit_done        Initializing … Datase… bit    
#>  3 .BITS         .BITS, bit_init, bit_done        Initializing … Datase… bit    
#>  4 .pt           .pt, .stroke                     Graphical uni… Datase… ggplot2
#>  5 Adobe_glyphs  Adobe_glyphs, charset_to_Unicode Conversion Ta… Datase… tools  
#>  6 Aids2         Aids2                            Australian AI… Datase… MASS   
#>  7 AirPassengers AirPassengers                    Monthly Airli… Datase… datase…
#>  8 Alfalfa       Alfalfa                          Split-Plot Ex… Datase… nlme   
#>  9 Animals       Animals                          Brain and Bod… Datase… MASS   
#> 10 Assay         Assay                            Bioassay on C… Datase… nlme   
#> # ℹ 381 more rows