ravelRy (version 0.1.0)

search_yarn: Search for yarn

Description

This function retrieves a list of basic yarn details based on search terms.

Usage

search_yarn(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 100

sort

options: `best`, `rating`, `projects`

...

pass any other filter parameters available via https://www.ravelry.com/yarns/search (ex. weight, needles, photo, fiberc, ya, ratings, origin)

Value

tibble containing basic pattern details, some nested

Examples

# NOT RUN {
search_yarn(query = 'cascade', page_size = 10)
# }
# NOT RUN {
# using site search parameters
# }
# NOT RUN {
search_yarn(query = 'cascade', sort = 'best', weight = 'sport', needles = '3.75mm')
# }
# NOT RUN {
# }