Skip to content

Latest commit

 

History

History
117 lines (81 loc) · 5.12 KB

README.md

File metadata and controls

117 lines (81 loc) · 5.12 KB

lterpalettefinder - Extract Color Palettes from Photos and Pick Official LTER Palettes

R-CMD-check GitHub issues GitHub pull requests

The goal of lterpalettefinder is to provide high quality color palettes derived from photos at Long Term Ecological Research (LTER) sites. This allows users to create beautiful graphics that have close visual ties to photos from the places where data were collected. This package also allows users to generate their own palettes from any photo (PNG, JPEG, TIFF, or HEIC) if the current palettes in the function do not meet their needs. For more information on the LTER Network, check out our website!

Installation

You can install the development version of lterpalettefinder from GitHub with:

# install.packages("devtools")
devtools::install_github("lter/lterpalettefinder")

R Shiny App

To help demonstrate some of the functionalities of lterpalettefinder we have created a standalone R Shiny app that allows for extracting a palette and demonstrating it entirely through a browser. While we developed this app primarily to support non-R users interested in lterpalettefinder we hope it is interesting and valuable to R experts as well! The GitHub repo for the Shiny app can be found here.

Functions

This package currently includes the following functions:

Use an Existing Palette

  • palette_find returns “official” palette(s) that we have already created that meet criteria you specify

Create Your Own Palette

  • palette_extract extracts 25 colors’ hexadecimal codes from a picture of your choosing (PNG, JPEG, TIFF, and HEIC formats are currently supported)

  • palette_sort sorts output of palette_extract by hue and saturation to approximate how human eyes group colors

  • palette_subsample randomly picks a user-specified number of hexadecimal codes from a vector of such codes

Demonstrate a Palette

  • palette_demo creates an exploratory base R graph from a vector of hexadecimal codes (like that returned by either palette_extract, ..._sort, or ..._subsample) and provides an option to export that plot if desired

  • palette_ggdemo creates an exploratory ggplot2 graph from a vector of hexadecimal codes (like that returned by either palette_extract, ..._sort, or ..._subsample)

Note that the vector of hexadecimal codes provided by palette_find when only one official palette meets criteria set by user will also be accepted by either palette_demo or ...ggdemo

Acknowledgements

Creation of this package was funded by National Science Foundation grant #1929393 awarded to F. Davis, J. Caselle, and M. Downs.

Gabriel De La Rosa designed our hex logo and provided valuable feedback on early versions of the package.

Thanks also to the whole LTER Network Office team and the broader NCEAS community!

Palette Examples

These palette examples were generated from photos at LTER sites.

Image Palette
Photo credit: SBC LTER

Arctic LTER + palette_ggdemo

Image Palette
Photo credit: Lindsay VanFossen
Image Palette
Photo credit: G.P. Robertson