Skip to content

Commit

Permalink
Merge pull request #23 from rsaporta/readme_minor_edits
Browse files Browse the repository at this point in the history
Minor edits to the readme
  • Loading branch information
jalvesaq committed Jun 9, 2018
2 parents ecc1126 + 40eecbc commit 68e289f
Showing 1 changed file with 27 additions and 14 deletions.
41 changes: 27 additions & 14 deletions README.md
Expand Up @@ -4,22 +4,27 @@ colorout
*colorout* is an R package that colorizes R output when running in a Unix
(e.g. Linux and OS X) terminal emulator; it does not work on Microsoft Windows.
The relevant code is written in C and, thus, it runs very quickly and you
should not note any slowdown in R output. R's `stdout` is parsed and numbers,
negative numbers, dates in the standard format, strings, and R constants are
identified and wrapped by special ansi scape codes that are interpreted by
terminal emulators as commands to colorize the output. R's `stderr` is also
parsed to identify the expressions "warning" and "error" and their
translations to many languages. If these expressions are found, the output is
colorized accordingly; otherwise, it is colorized as "stderror" (magenta, by
default). You can customize the colors according to your preference, guided by the
color table made by the command `show256Colors()`. You can also set the colors
to any arbitrary string. In this case, it is up to you to set valid values.
should not note any slowdown in R output.

The package cannot be on CRAN because it changes code already loaded by R and
this is prohibited by the *CRAN Repository Policy*. The package replaces the
functions that output results and messages to R Console, and this is necessary
because we cannot colorize the output without replacing these functions.
R's `stdout` is parsed and numbers, negative numbers, dates in the standard
format, strings, indices, and R constants are identified and wrapped by special
ansi escape codes that are interpreted by terminal emulators as commands to
colorize the output.

R's `stderr` is also parsed to identify the expressions "warning" and "error"
and their translations to many languages. If these expressions are found, the
output is colorized accordingly; otherwise, it is colorized as "stderror"
(magenta, by default).


### Customization
You can customize the colors according to your preference, guided by the
color table made by the command `show256Colors()`.
You can also set the colors to any arbitrary string. In this case, it is
up to you to set valid values.


### Installation
You can install the package by running the following commands in a terminal
emulator:

Expand All @@ -32,6 +37,14 @@ Some people prefer to use
[devtools](http://cran.r-project.org/web/packages/devtools/index.html) to
install packages from github.

_NOTE_:
The package cannot be on CRAN because it changes code already loaded by R and
this is prohibited by the *CRAN Repository Policy*. The package replaces the
functions that output results and messages to R Console, and this is necessary
because we cannot colorize the output without replacing these functions.


### Previous Versions:
Recently released versions are available at
https://github.com/jalvesaq/colorout/releases and older versions are at
https://drive.google.com/open?id=0ByMBQcSs9G7KYkotRGpRYjlLVDg
Expand Down

0 comments on commit 68e289f

Please sign in to comment.