https://github.com/akgold/stickr

An R package to use RStudio Hex Stickers.
https://github.com/akgold/stickr

Last synced: 2 days ago
JSON representation

An R package to use RStudio Hex Stickers.

• Host: GitHub
• URL: https://github.com/akgold/stickr
• Owner: akgold
• License: other
• Created: 2020-02-26T17:31:39.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-26T15:37:58.000Z (about 4 years ago)
• Last Synced: 2024-08-13T07:14:55.537Z (3 months ago)
• Language: R
• Size: 1.56 MB
• Stars: 32
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - akgold/stickr - An R package to use RStudio Hex Stickers. (R)

README

        
# stickr



[![codecov](https://codecov.io/gh/akgold/stickr/branch/master/graph/badge.svg)](https://codecov.io/gh/akgold/stickr)

The goal of stickr is to make it easier for you to include any R package hex stickers in your work.

## Installation

You can install the released version of stickr from [GitHub](https://github.com/akgold/stickr) with:

``` r

remotes::install_github("akgold/stickr")

```

## Example

This is a basic example which shows you how to find and download a sticker:

``` r

library(stickr)

# Get the tidyverse sticker, downloads to temp file if no destfile specified

stickr_get("tidyverse")

# Get a sticker that's not in the RStudio repository

stickr_get("textmineR")

# But that's the old sticker, get the new one by name

stickr_get("textmineR", filename = "textmineR_v8.png")

```

A common use case would be to include in an [R Markdown](https://rmarkdown.rstudio.com/) document, 

that would be done using `stickr_insert("tidyverse")`. If trying to insert inline, consider using `dpi` argument.

# GitHub Rate Limits

If you're performing unauthenticated calls to get stickers, you'll probably hit rate limits quite quickly. See the [gh](https://github.com/r-lib/gh) package documentation for details on how to provide a GitHub PAT to authenticate and get higher rate limits.

# Package Maintainers

Want to make sure users can get your sticker with `stickr`? Two steps!

1. Make sure your package's DESCRIPTION file includes a [URL and/or BugReport field field](https://www.r-bloggers.com/about-urls-in-description/) that points to your package's GitHub repository.

2. Put your hex sticker in the `/man/figures` directory inside your package -- one named `logo.png` will be used by default, but other names are ok too.