Retrieve a color palette or set of palletes from the COLOURlovers API.
1 2 3
The COLOURlovers id (an integer) for a specific palette.
A boolean indicating whether to include the color widths for the palette. Default is
Optionally, a subset of COLOURlovers palettes. Allowed values are “new”, “top”, and “random”.
A named list of parameters passed to the API request. Allowed parameters are
A format for the API response, one of “xml” (the default) or “json”. This has essentially no effect on function behavior.
Retrieve details about a palette or set of palettes.
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.
keywordsExact: 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
A list of class “clpalette”. This should be the same regardless of the value of
Thomas J. Leeper
1 2 3 4 5 6 7 8 9 10 11 12
e <- function(e) NULL # function for tryCatch to fail in examples # get a random palette tryCatch( clpalettes('random'), error = e) # download top palettes tryCatch( clpalettes('top', fmt='json'), error = e) # plot at a single palette pid <- '113451' p <- tryCatch( clpalette(pid, fmt='json'), error = e) if(!is.null(p)) plot(p)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.