search_groups: Search groups

In ravelRy: An Interface to the 'Ravelry' API

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')

# with site search parameters
## Not run: search_groups(query = 'star wars', gc = 'knitting')

ravelRy documentation built on Feb. 19, 2020, 5:07 p.m.