• Stars
    star
    321
  • Rank 119,994 (Top 3 %)
  • Language
    R
  • License
    Other
  • Created about 9 years ago
  • Updated about 1 month 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,331
star
2

lintr

Static Code Analysis for R
R
1,122
star
3

httr

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

actions

GitHub Actions for the R community
JavaScript
868
star
5

testthat

An R ๐Ÿ“ฆ to make testing ๐Ÿ˜€
R
849
star
6

usethis

Set up commonly used ๐Ÿ“ฆ components
R
798
star
7

pkgdown

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

styler

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

pak

A fresh approach to package installation
C
575
star
10

cli

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

roxygen2

Generate R package documentation from inline R comments
R
553
star
12

rig

The R Installation Manager
Rust
460
star
13

rlang

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

progress

Progress bar in your R terminal
R
447
star
15

R6

Encapsulated object-oriented programming for R
R
393
star
16

here

A simpler way to find your files
R
387
star
17

scales

Tools for ggplot2 scales
R
370
star
18

fs

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

covr

Test coverage reports for R
R
328
star
20

rex

Friendly regular expressions for R.
R
325
star
21

memoise

Easy memoisation for R
R
310
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
309
star
23

lobstr

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

callr

Call R from R
R
281
star
25

waldo

Find differences between R objects
R
272
star
26

vctrs

Generic programming with typed R vectors
C
272
star
27

slider

Sliding Window Functions
R
267
star
28

zeallot

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

conflicted

An alternative conflict resolution strategy for R
R
242
star
30

bench

High Precision Timing of R Expressions
R
237
star
31

gmailr

Access the Gmail RESTful API from R.
R
234
star
32

processx

Execute and Control Subprocesses from R
R
225
star
33

xml2

Bindings to libxml2
R
213
star
34

asciicast

Turn R scripts into terminal screencasts
R
211
star
35

gh

Minimalistic GitHub API client in R
R
210
star
36

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
203
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
185
star
38

keyring

๐Ÿ” Access the system credential store from R
R
185
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
177
star
40

svglite

A lightweight svg graphics device for R
C++
177
star
41

pillar

Format columns with colour
R
173
star
42

ragg

Graphic Devices Based on AGG
C++
169
star
43

ymlthis

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

hugodown

Make websites with hugo and RMarkdown
R
163
star
45

withr

Methods For Temporarily Modifying Global State
R
158
star
46

rprojroot

Finding files in project subdirectories
R
146
star
47

coro

Coroutines for R
R
146
star
48

debugme

Easy and efficient debugging for R packages
R
144
star
49

available

Check if a package name is available to use
R
141
star
50

ellipsis

Tools for Working with ...
R
138
star
51

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
138
star
52

gert

Simple git client for R
C
135
star
53

itdepends

R
133
star
54

later

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

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
128
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
126
star
58

fastmap

Fast map implementation for R
C++
124
star
59

tidyselect

A backend for functions taking tidyverse selections
R
122
star
60

desc

Manipulate DESCRIPTION files
R
120
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
112
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
110
star
63

evaluate

A version of eval for R that returns more information about what happened
R
107
star
64

prettycode

Syntax highlight R code in the terminal
R
100
star
65

mockery

A mocking library for R.
R
99
star
66

sloop

S language OOP โ›ต๏ธ
R
98
star
67

pkgdepends

R Package Dependency Resolution
R
93
star
68

revdepcheck

R package reverse dependency checking
R
93
star
69

clock

A Date-Time Library for R
R
93
star
70

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
71

systemfonts

System Native Font Handling in R
C++
90
star
72

gtable

The layout packages that powers ggplot2
R
85
star
73

askpass

Password Entry for R, Git, and SSH
R
83
star
74

rappdirs

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

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
81
star
76

zip

Platform independent zip compression via miniz
C
81
star
77

downlit

Syntax Highlighting and Automatic Linking
R
80
star
78

clisymbols

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

tree-sitter-r

C
74
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
69
star
83

credentials

Tools for Managing SSH and Git Credentials
R
69
star
84

roxygen2md

Convert elements of roxygen documentation to markdown
R
69
star
85

sodium

R bindings to libsodium
R
68
star
86

backports

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

pkgbuild

Find tools needed to build R packages
R
65
star
88

cliapp

Rich Command Line Applications
R
62
star
89

webfakes

Fake web apps for HTTP testing R packages
C
61
star
90

generics

Common generic methods
R
60
star
91

diffviewer

HTML widget to visually compare files
JavaScript
57
star
92

pkgload

Simulate installing and loading a package
R
55
star
93

liteq

Serverless R message queue using SQLite
R
55
star
94

cachem

Key-value caches for R
R
54
star
95

carrier

Create standalone functions for remote execution
R
49
star
96

brio

Basic R Input Output
R
49
star
97

jose

Javascript Object Signing and Encryption for R
R
47
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
46
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star