clpatterns: Retrieve pattern or patterns

In leeper/colourlovers: R Client for the COLOURlovers API

Retrieve pattern or patterns

Description

Retrieve a pattern or set of patterns from the COLOURlovers API.

Usage

clpatterns(set = NULL, ..., fmt = "xml")

clpattern(id, fmt = "xml")

Arguments

set	Optionally, a subset of COLOURlovers patterns. Allowed values are “new”, “top”, and “random”.
...	A named list of parameters passed to the API request. Allowed parameters are lover, hueOption, hex, hex_logic, keywords, keywordExact, orderCol, sortBy, numResults, and resultOffset. Specifying orderCol overrules any argument to set. See details.
fmt	A format for the API response, one of “xml” (the default) or “json”. This has essentially no effect on function behavior.
id	The COLOURlovers id (an integer) for a specific pattern.

Details

Retrieve details about a pattern or set of patterns.

Specifying named arguments to ... allows the user to request a specific response, as follows:

• lover: A character string containing a COLOURlovers username.

• hueOption: A character vector containing one or more named hues to search by. Allowed values are: “red”, “orange”, “yellow”, “green”, “aqua”, “blue”, “violet”, “fuchsia”. Any other values other than these named colors will be ignored.

• hex: A character vector containing up to five colors specified as hexidecimal representation (with or without a leading hash symbol). Excess colors will be ignored.

• hex_logic: A character value containing either “AND” (the default) or “OR”, for whether the values in hex should be searched for with a boolean AND versus OR logic. Specifying “AND” will only return palettes with all requested colors.

• keywords: A character string containing one or more keywords to search by.

• keywordExact: A boolean indicating search on keywords should be exact (TRUE) or not (FALSE, the API default).

• orderCol: A character string containing a sort criterion. One of “dateCreated”, “score”, “name”, “numVotes”, “numViews”.

• sortBy: A character string containing either “ASC” (for ascending by the orderCol criterion, the default) or “DSC” (for descending).

• numResults: A numeric value indicating the number of results to return, with a maximum of 100. Default is 20.

• resultOffset: A numeric value indicating the page of results to return, with page size specified in the numResults argument.

Value

A list of class “clpattern”. This should be the same regardless of the value of fmt.

Author(s)

Thomas J. Leeper

References

http://www.colourlovers.com/api/#patterns

Examples

## Not run: 
# Get a random pattern
clpatterns('random')

# Plot a single pattern
p <- clpattern('1451', fmt = 'json')
plot(p)

## End(Not run)

leeper/colourlovers documentation built on Aug. 24, 2022, 4:24 a.m.