ravelRy (version 0.1.0)

search_groups: Search groups

Description

This function retrieves groups based on search terms.

Usage

search_groups(query = NULL, page = NULL, page_size = NULL,
  sort = NULL, ...)

Arguments

query

search string

page

result page to retrieve; defaults to first page

page_size

number of results to retrieve; defaults to 50

sort

options: `best`, `added`, `favorites`

...

pass any other filter parameters available via https://www.ravelry.com/groups/search (ex. creation, gc)

Value

tibble containing group information, like name, created_at, short_description, etc.

Examples

# NOT RUN {
search_groups(query = 'star wars')
# }
# NOT RUN {
# with site search parameters
# }
# NOT RUN {
search_groups(query = 'star wars', gc = 'knitting')
# }
# NOT RUN {
# }