• Stars
    star
    325
  • Rank 128,979 (Top 3 %)
  • Language
    R
  • License
    Other
  • Created about 10 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

🖍️ R package for colored terminal output — now superseded by cli

🚀 crayon is now superseded by the cli package. 🚀

Please use cli for new projects.

crayon is still supported and will receive important bug fixes, but no new features.



crayon


Stylish terminal output in R

Lifecycle: superseded CRAN RStudio mirror downloads R-CMD-check Codecov test coverage

With crayon it is easy to add color to terminal output, create styles for notes, warnings, errors; and combine styles.

ANSI color support is automatically detected and used. Crayon was largely inspired by chalk.

Installation

Stable version:

install.packages("crayon")

Development version:

pak::pak("r-lib/crayon")

Styles

Crayon defines several styles that can be combined. Each style in the list has a corresponding function with the same name.

General styles

  • reset
  • bold
  • blurred (usually called dim, renamed to avoid name clash)
  • italic (not widely supported)
  • underline
  • inverse
  • hidden
  • strikethrough (not widely supported)

Text colors

  • black
  • red
  • green
  • yellow
  • blue
  • magenta
  • cyan
  • white
  • silver (usually called gray, renamed to avoid name clash)

Background colors

  • bgBlack
  • bgRed
  • bgGreen
  • bgYellow
  • bgBlue
  • bgMagenta
  • bgCyan
  • bgWhite

Screenshot on OSX

Usage

The styling functions take any number of character vectors as arguments, and they concatenate and style them:

library(crayon)
cat(blue("Hello", "world!\n"))

Crayon defines the %+% string concatenation operator to make it easy to assemble strings with different styles.

cat("... to highlight the " %+% red("search term") %+% " in a block of text\n")

Styles can be combined using the $ operator:

cat(yellow$bgMagenta$bold('Hello world!\n'))

Styles can also be nested, and then inner style takes precedence:

cat(green(
  'I am a green line ' %+%
  blue$underline$bold('with a blue substring') %+%
  ' that becomes green again!\n'
))

It is easy to define your own themes:

error <- red $ bold
warn <- magenta $ underline
note <- cyan
cat(error("Error: subscript out of bounds!\n"))
cat(warn("Warning: shorter argument was recycled.\n"))
cat(note("Note: no such directory.\n"))

256 colors

Most modern terminals support the ANSI standard for 256 colors, and you can define new styles that make use of them. The make_style function defines a new style. It can handle R's built in color names (see the output of colors()) as well as RGB specifications via the rgb() function. It automatically chooses the ANSI colors that are closest to the specified R and RGB colors, and it also has a fallback to terminals with 8 ANSI colors only.

ivory <- make_style("ivory")
bgMaroon <- make_style("maroon", bg = TRUE)
fancy <- combine_styles(ivory, bgMaroon)
cat(fancy("This will have some fancy colors"), "\n")

License

MIT @ Gábor Csárdi

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,392
star
2

lintr

Static Code Analysis for R
R
1,189
star
3

httr

httr: a friendly http package for R
R
984
star
4

actions

GitHub Actions for the R community
TypeScript
948
star
5

testthat

An R 📦 to make testing 😀
R
875
star
6

usethis

Set up commonly used 📦 components
R
842
star
7

pkgdown

Generate static html documentation for an R package
R
714
star
8

styler

Non-invasive pretty printing of R code
R
706
star
9

pak

A fresh approach to package installation
C
652
star
10

cli

Tools for making beautiful & useful command line interfaces
R
635
star
11

rig

The R Installation Manager
Rust
609
star
12

roxygen2

Generate R package documentation from inline R comments
R
590
star
13

rlang

Low-level API for programming with R
R
498
star
14

progress

Progress bar in your R terminal
R
463
star
15

here

A simpler way to find your files
R
410
star
16

R6

Encapsulated object-oriented programming for R
R
405
star
17

scales

Tools for ggplot2 scales
R
392
star
18

fs

Provide cross platform file operations based on libuv.
C
362
star
19

rex

Friendly regular expressions for R.
R
331
star
20

covr

Test coverage reports for R
R
331
star
21

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
325
star
22

memoise

Easy memoisation for R
R
315
star
23

lobstr

Understanding complex R objects with tools similar to str()
R
301
star
24

profvis

Visualize R profiling data
JavaScript
297
star
25

callr

Call R from R
R
295
star
26

slider

Sliding Window Functions
R
295
star
27

vctrs

Generic programming with typed R vectors
C
284
star
28

waldo

Find differences between R objects
R
275
star
29

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
253
star
30

conflicted

An alternative conflict resolution strategy for R
R
244
star
31

bench

High Precision Timing of R Expressions
R
241
star
32

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
232
star
33

gmailr

Access the Gmail RESTful API from R.
R
229
star
34

processx

Execute and Control Subprocesses from R
R
229
star
35

asciicast

Turn R scripts into terminal screencasts
R
224
star
36

xml2

Bindings to libxml2
R
218
star
37

gh

Minimalistic GitHub API client in R
R
218
star
38

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
199
star
39

keyring

🔐 Access the system credential store from R
R
191
star
40

vdiffr

Visual regression testing and graphical diffing with testthat
C++
182
star
41

pillar

Format columns with colour
R
179
star
42

svglite

A lightweight svg graphics device for R
C++
179
star
43

withr

Methods For Temporarily Modifying Global State
R
173
star
44

ragg

Graphic Devices Based on AGG
C++
172
star
45

hugodown

Make websites with hugo and RMarkdown
R
166
star
46

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
47

coro

Coroutines for R
R
153
star
48

rprojroot

Finding files in project subdirectories
R
148
star
49

debugme

Easy and efficient debugging for R packages
R
146
star
50

available

Check if a package name is available to use
R
142
star
51

gert

Simple git client for R
C
142
star
52

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
142
star
53

ellipsis

Tools for Working with ...
R
141
star
54

later

Schedule an R function or formula to run after a specified period of time.
C++
136
star
55

itdepends

R
133
star
56

fastmap

Fast map implementation for R
C++
132
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
131
star
58

rray

Simple Arrays
R
130
star
59

isoband

isoband: An R package to generate contour lines and polygons.
C++
130
star
60

tidyselect

A backend for functions taking tidyverse selections
R
123
star
61

desc

Manipulate DESCRIPTION files
R
121
star
62

evaluate

A version of eval for R that returns more information about what happened
R
118
star
63

gargle

Infrastructure for calling Google APIs from R, including auth
R
114
star
64

rcmdcheck

Run R CMD check from R and collect the results
R
113
star
65

tree-sitter-r

R
106
star
66

prettycode

Syntax highlight R code in the terminal
R
101
star
67

sloop

S language OOP ⛵️
R
101
star
68

clock

A Date-Time Library for R
R
100
star
69

mockery

A mocking library for R.
R
99
star
70

revdepcheck

R package reverse dependency checking
R
99
star
71

pkgdepends

R Package Dependency Resolution
R
94
star
72

lifecycle

Manage the life cycle of your exported functions and arguments
R
92
star
73

systemfonts

System Native Font Handling in R
C++
91
star
74

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
88
star
75

downlit

Syntax Highlighting and Automatic Linking
R
86
star
76

gtable

The layout packages that powers ggplot2
R
86
star
77

askpass

Password Entry for R, Git, and SSH
R
84
star
78

zip

Platform independent zip compression via miniz
C
83
star
79

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
82
star
80

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
79
star
81

marquee

Markdown Parser and Renderer for R Graphics
C
77
star
82

ps

R package to query, list, manipulate system processes
C
73
star
83

credentials

Tools for Managing SSH and Git Credentials
R
72
star
84

sessioninfo

Print Session Information
R
72
star
85

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
70
star
86

sodium

R bindings to libsodium
R
69
star
87

roxygen2md

Convert elements of roxygen documentation to markdown
R
67
star
88

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
66
star
89

pkgbuild

Find tools needed to build R packages
R
65
star
90

webfakes

Fake web apps for HTTP testing R packages
C
63
star
91

generics

Common generic methods
R
61
star
92

cliapp

Rich Command Line Applications
R
61
star
93

diffviewer

HTML widget to visually compare files
JavaScript
58
star
94

pkgload

Simulate installing and loading a package
R
58
star
95

cachem

Key-value caches for R
R
57
star
96

liteq

Serverless R message queue using SQLite
R
56
star
97

brio

Basic R Input Output
R
53
star
98

carrier

Create standalone functions for remote execution
R
50
star
99

jose

Javascript Object Signing and Encryption for R
R
48
star
100

urlchecker

Run CRAN URL checks from older versions of R
R
45
star