Add vignette for plt_tize() #12
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gvelasq
requested changes
Apr 26, 2023
| ) | ||
| ``` | ||
|
|
||
| This vignette demonstrates how to use the {palettizer} package to generate a color palette from an image and apply it to a {ggplot2} plot using the palmerpenguins dataset. |
There was a problem hiding this comment.
Should palmerpenguins have curly braces like the other package names? Or no curly braces for any package?
There was a problem hiding this comment.
Do you have a preference? I'll go through and make sure they all match.
There was a problem hiding this comment.
I prefer no curly braces as per tidyverse style.
| The {palettizer} package generates a color palette from an image using K-means clustering. The algorithm works as follows: | ||
|
|
||
| 1. The image is first resized to a smaller version for faster processing. | ||
| 2. The colors of the image are then represented in the LAB color space, which is more perceptually uniform compared to RGB. |
There was a problem hiding this comment.
|
|
||
| ```{r generate-palette} | ||
| plt_vector <- | ||
| palettizer::plt_tize("lter_penguins.png", cluster_count = 3) |
There was a problem hiding this comment.
I don't think you need the palettizer:: since you've already loaded the package, and this can all likely go in a single line.
| palettizer::plt_tize("lter_penguins.png", cluster_count = 3) | ||
| ``` | ||
|
|
||
| ## Create a {ggplot2} plot with the generated color palette |
There was a problem hiding this comment.
Suggest: Create a plot with the generated color palette.
|
|
||
| ## Create a {ggplot2} plot with the generated color palette | ||
|
|
||
| Finally, we will create a {ggplot2} plot using the palmerpenguins dataset and apply the generated color palette: |
There was a problem hiding this comment.
As above, ggplot2 plot seems redundant here.
| scale_color_manual(values = plt_vector) + | ||
| labs( | ||
| title = "Flipper and bill length", | ||
| subtitle = "Dimensions for Adelie, Chinstrap and Gentoo Penguins at Palmer Station LTER", |
| flipper_bill | ||
| ``` | ||
|
|
||
| This creates a {ggplot2} plot with the color palette generated from the image applied to the data points. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #11
Add vignette for plt_tize() 🐧