Tinyurl
You can also put a tinyurl link as a watermark on the image produced that will open to the carbon.now.sh page that has the code in the image. ```{r,echo=FALSE} Sys.sleep(2) ``` ```{r} x$add_tinyurl <- TRUE x$carbonate(file = 'tiny_url.png') ``` If you just want the tinyurl link without the image to use in a tweet you can create it using ```{r} x$tiny() ``` Or you can put the link directly on your clipboard ```{r, eval = interactive()} x$tiny(clip = TRUE) clipr::read_clip() ```Combining
```{r} x$carbons%>% magick::image_scale('300')%>% magick::image_append() x$carbons%>% magick::image_scale('300')%>% magick::image_append(stack = TRUE) ```GIFs
```{r} x$carbons%>% magick::image_animate(fps = 1) ```Tinyurl
You can also put a tinyurl link as a watermark on the image produced that will open to the carbon.now.sh page that has the code in the image. ``` r x$add_tinyurl <- TRUE x$carbonate(file = 'tiny_url.png') ```  If you just want the tinyurl link without the image to use in a tweet you can create it using ``` r x$tiny() #> [1] "https://tinyurl.com/2n72r6pk" ``` Or you can put the link directly on your clipboard ``` r x$tiny(clip = TRUE) clipr::read_clip() ```Combining
``` r x$carbons%>% magick::image_scale('300')%>% magick::image_append() ```  ``` r x$carbons%>% magick::image_scale('300')%>% magick::image_append(stack = TRUE) ``` GIFs
``` r x$carbons%>% magick::image_animate(fps = 1) ``` Page not found (404)
License
YEAR: 2018 COPYRIGHT HOLDER: Jonathan Sidi
NA
Hi, thanks for contributing!
Please make sure you read our CONTRIBUTING guide.
Please fill the fields above:
Articles
All vignettes
Tests and Coverage
21 August, 2022 21:06:53
Source:vignettes/tests_and_coverage.Rmd
tests_and_coverage.RmdThis output is created by covrpage.
Coverage
Coverage summary is created using the covr package.
| Object | Coverage (%) |
|---|---|
| carbonate | 48.58 |
| R/carbonate.R | 0.00 |
| R/selenium_functions.R | 0.00 |
| R/uri_functions.R | 52.63 |
| R/carbon.R | 64.29 |
| R/helpers.R | 70.09 |
| R/set_get_functions.R | 100.00 |
Unit Tests
Unit Test summary is created using the testthat package.
| file | n | time | error | failed | skipped | warning | icon |
|---|---|---|---|---|---|---|---|
| test-set.R | 3 | 0.013 | 0 | 0 | 0 | 0 | |
| test-uri.R | 8 | 1.352 | 0 | 0 | 1 | 0 | 🔶 |
| test-yml.R | 6 | 0.017 | 0 | 0 | 0 | 0 |
Show Detailed Test Results
| file | context | test | status | n | time | icon |
|---|---|---|---|---|---|---|
| test-set.R | set_ | set functions: set_template | PASS | 1 | 0.011 | |
| test-set.R | set_ | set functions: set_font_family | PASS | 1 | 0.001 | |
| test-set.R | set_ | set functions: set_windows_control_theme | PASS | 1 | 0.001 | |
| test-uri.R | uri | options: benchmark | PASS | 1 | 0.002 | |
| test-uri.R | uri | uri: benchmark | PASS | 1 | 0.002 | |
| test-uri.R | uri | uri: 200 | PASS | 1 | 0.721 | |
| test-uri.R | uri | encode: encode character | PASS | 1 | 0.002 | |
| test-uri.R | uri | encode: no encode character | PASS | 1 | 0.001 | |
| test-uri.R | uri | tiny: valid tiny | PASS | 1 | 0.620 | |
| test-uri.R | uri | tiny: clipboard | SKIPPED | 1 | 0.001 | 🔶 |
| test-uri.R | uri | bad template: error uri | PASS | 1 | 0.003 | |
| test-yml.R | yml | yaml fields: rgba | PASS | 1 | 0.006 | |
| test-yml.R | yml | yaml fields: template | PASS | 1 | 0.003 | |
| test-yml.R | yml | yaml fields: bad font family | PASS | 1 | 0.002 | |
| test-yml.R | yml | yaml fields: pv | PASS | 1 | 0.002 | |
| test-yml.R | yml | yaml fields: ph | PASS | 1 | 0.002 | |
| test-yml.R | yml | namesless palette: fill in palette | PASS | 1 | 0.002 |
| Failed | Warning | Skipped |
|---|---|---|
| 🛑 | ⚠️ | 🔶 |
Session Info
| Field | Value |
|---|---|
| Version | R version 3.5.1 (2018-07-02) |
| Platform | x86_64-apple-darwin15.6.0 (64-bit) |
| Running | macOS 10.14.2 |
| Language | en_US |
| Timezone | America/Chicago |
| Package | Version |
|---|---|
| testthat | 2.0.0.9000 |
| covr | 3.2.0 |
| covrpage | 0.0.69 |
`, then ``, etc.) that has more than one element. Defaults to 1 (for ``).
getTopLevel: function($scope) {
for (var i = 1; i <= 6; i++) {
var $headings = this.findOrFilter($scope, 'h' + i);
if ($headings.length > 1) {
return i;
}
}
return 1;
},
// returns the elements for the top level, and the next below it
getHeadings: function($scope, topLevel) {
var topSelector = 'h' + topLevel;
var secondaryLevel = topLevel + 1;
var secondarySelector = 'h' + secondaryLevel;
return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
},
getNavLevel: function(el) {
return parseInt(el.tagName.charAt(1), 10);
},
populateNav: function($topContext, topLevel, $headings) {
var $context = $topContext;
var $prevNav;
var helpers = this;
$headings.each(function(i, el) {
var $newNav = helpers.generateNavItem(el);
var navLevel = helpers.getNavLevel(el);
// determine the proper $context
if (navLevel === topLevel) {
// use top level
$context = $topContext;
} else if ($prevNav && $context === $topContext) {
// create a new level of the tree and switch to it
$context = helpers.createChildNavList($prevNav);
} // else use the current $context
$context.append($newNav);
$prevNav = $newNav;
});
},
parseOps: function(arg) {
var opts;
if (arg.jquery) {
opts = {
$nav: arg
};
} else {
opts = arg;
}
opts.$scope = opts.$scope || $(document.body);
return opts;
}
},
// accepts a jQuery object, or an options object
init: function(opts) {
opts = this.helpers.parseOps(opts);
// ensure that the data attribute is in place for styling
opts.$nav.attr('data-toggle', 'toc');
var $topContext = this.helpers.createChildNavList(opts.$nav);
var topLevel = this.helpers.getTopLevel(opts.$scope);
var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
this.helpers.populateNav($topContext, topLevel, $headings);
}
};
$(function() {
$('nav[data-toggle="toc"]').each(function(i, el) {
var $nav = $(el);
Toc.init($nav);
});
});
})();
================================================
FILE: docs/docsearch.css
================================================
/* Docsearch -------------------------------------------------------------- */
/*
Source: https://github.com/algolia/docsearch/
License: MIT
*/
.algolia-autocomplete {
display: block;
-webkit-box-flex: 1;
-ms-flex: 1;
flex: 1
}
.algolia-autocomplete .ds-dropdown-menu {
width: 100%;
min-width: none;
max-width: none;
padding: .75rem 0;
background-color: #fff;
background-clip: padding-box;
border: 1px solid rgba(0, 0, 0, .1);
box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);
}
@media (min-width:768px) {
.algolia-autocomplete .ds-dropdown-menu {
width: 175%
}
}
.algolia-autocomplete .ds-dropdown-menu::before {
display: none
}
.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {
padding: 0;
background-color: rgb(255,255,255);
border: 0;
max-height: 80vh;
}
.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
margin-top: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion {
padding: 0;
overflow: visible
}
.algolia-autocomplete .algolia-docsearch-suggestion--category-header {
padding: .125rem 1rem;
margin-top: 0;
font-size: 1.3em;
font-weight: 500;
color: #00008B;
border-bottom: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
float: none;
padding-top: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
float: none;
width: auto;
padding: 0;
text-align: left
}
.algolia-autocomplete .algolia-docsearch-suggestion--content {
float: none;
width: auto;
padding: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--content::before {
display: none
}
.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {
padding-top: .75rem;
margin-top: .75rem;
border-top: 1px solid rgba(0, 0, 0, .1)
}
.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {
display: block;
padding: .1rem 1rem;
margin-bottom: 0.1;
font-size: 1.0em;
font-weight: 400
/* display: none */
}
.algolia-autocomplete .algolia-docsearch-suggestion--title {
display: block;
padding: .25rem 1rem;
margin-bottom: 0;
font-size: 0.9em;
font-weight: 400
}
.algolia-autocomplete .algolia-docsearch-suggestion--text {
padding: 0 1rem .5rem;
margin-top: -.25rem;
font-size: 0.8em;
font-weight: 400;
line-height: 1.25
}
.algolia-autocomplete .algolia-docsearch-footer {
width: 110px;
height: 20px;
z-index: 3;
margin-top: 10.66667px;
float: right;
font-size: 0;
line-height: 0;
}
.algolia-autocomplete .algolia-docsearch-footer--logo {
background-image: url("data:image/svg+xml;utf8,");
background-repeat: no-repeat;
background-position: 50%;
background-size: 100%;
overflow: hidden;
text-indent: -9000px;
width: 100%;
height: 100%;
display: block;
transform: translate(-8px);
}
.algolia-autocomplete .algolia-docsearch-suggestion--highlight {
color: #FF8C00;
background: rgba(232, 189, 54, 0.1)
}
.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)
}
.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {
background-color: rgba(192, 192, 192, .15)
}
================================================
FILE: docs/docsearch.js
================================================
$(function() {
// register a handler to move the focus to the search bar
// upon pressing shift + "/" (i.e. "?")
$(document).on('keydown', function(e) {
if (e.shiftKey && e.keyCode == 191) {
e.preventDefault();
$("#search-input").focus();
}
});
$(document).ready(function() {
// do keyword highlighting
/* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
var mark = function() {
var referrer = document.URL ;
var paramKey = "q" ;
if (referrer.indexOf("?") !== -1) {
var qs = referrer.substr(referrer.indexOf('?') + 1);
var qs_noanchor = qs.split('#')[0];
var qsa = qs_noanchor.split('&');
var keyword = "";
for (var i = 0; i < qsa.length; i++) {
var currentParam = qsa[i].split('=');
if (currentParam.length !== 2) {
continue;
}
if (currentParam[0] == paramKey) {
keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
}
}
if (keyword !== "") {
$(".contents").unmark({
done: function() {
$(".contents").mark(keyword);
}
});
}
}
};
mark();
});
});
/* Search term highlighting ------------------------------*/
function matchedWords(hit) {
var words = [];
var hierarchy = hit._highlightResult.hierarchy;
// loop to fetch from lvl0, lvl1, etc.
for (var idx in hierarchy) {
words = words.concat(hierarchy[idx].matchedWords);
}
var content = hit._highlightResult.content;
if (content) {
words = words.concat(content.matchedWords);
}
// return unique words
var words_uniq = [...new Set(words)];
return words_uniq;
}
function updateHitURL(hit) {
var words = matchedWords(hit);
var url = "";
if (hit.anchor) {
url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
} else {
url = hit.url + '?q=' + escape(words.join(" "));
}
return url;
}
================================================
FILE: docs/index.html
================================================
Interact with carbon.js • carbonate
“carbon.js is the easiest way to create beautiful images of your source code.”
This package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
Like the image below:
Installation
#remotes::install_github('yonicd/carbonate')
install.packages('carbonate')
Usage
Initialize new carbon object
The default code in the carbon object is taken from the clipboard.
x <- carbon$new()
But can also be defined inline. Code can be a character object of any length.
The code is kept in the object and can be changed at any time.
x$code
#> [1] "Package: carbonate"
#> [2] "Title: Interact with 'carbon.js'"
#> [3] "Version: 0.2.0"
#> [4] "Authors@R: "
#> [5] " person(given = \"Jonathan\","
#> [6] " family = \"Sidi\","
#> [7] " role = c(\"aut\", \"cre\"),"
#> [8] " email = \"yonicd@gmail.com\","
#> [9] " comment = c(ORCID = \"0000-0002-4222-1819\"))"
#> [10] "Description: Create beautiful images of source code using"
#> [11] " 'carbon.js'<https://carbon.now.sh/about>."
#> [12] "License: MIT + file LICENSE"
#> [13] "URL: https://github.com/yonicd/carbonate"
#> [14] "BugReports: https://github.com/yonicd/carbonate/issues"
#> [15] "Depends: "
#> [16] " R (>= 3.2.0)"
#> [17] "Imports: "
#> [18] " clipr,"
#> [19] " details,"
#> [20] " httpuv,"
#> [21] " httr,"
#> [22] " magick,"
#> [23] " R6,"
#> [24] " reprex,"
#> [25] " RSelenium,"
#> [26] " rtweet,"
#> [27] " utils,"
#> [28] " wdman,"
#> [29] " jsonlite,"
#> [30] " yaml"
#> [31] "Suggests: "
#> [32] " covr,"
#> [33] " knitr,"
#> [34] " rmarkdown,"
#> [35] " testthat"
#> [36] "VignetteBuilder: "
#> [37] " knitr"
#> [38] "RdMacros: "
#> [39] " details"
#> [40] "Encoding: UTF-8"
#> [41] "LazyData: true"
#> [42] "Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)"
#> [43] "RoxygenNote: 7.2.1"
The main job of the R6 object is to convert all the options into a uri that is sent to the carbon url page, where it is processed.
x$uri()
#> [1] "https://carbon.now.sh/?bg=rgba(171%2C175%2C195%2C0.7)&t=panda-syntax&wt=none&l=r&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=11px&ph=14px&ln=false&fm=Fira%20Code&fs=14px&lh=133%25&si=false&es=1x&wm=false&ts=false&code=Package%253A%2520carbonate%250ATitle%253A%2520Interact%2520with%2520%27carbon.js%27%250AVersion%253A%25200.2.0%250AAuthors%2540R%253A%2520%250A%2520%2520%2520%2520person(given%2520%253D%2520%2522Jonathan%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520family%2520%253D%2520%2522Sidi%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520role%2520%253D%2520c(%2522aut%2522%252C%2520%2522cre%2522)%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520email%2520%253D%2520%2522yonicd%2540gmail.com%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520comment%2520%253D%2520c(ORCID%2520%253D%2520%25220000-0002-4222-1819%2522))%250ADescription%253A%2520Create%2520beautiful%2520images%2520of%2520source%2520code%2520using%250A%2520%2520%2520%2520%27carbon.js%27%253Chttps%253A%252F%252Fcarbon.now.sh%252Fabout%253E.%250ALicense%253A%2520MIT%2520%252B%2520file%2520LICENSE%250AURL%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%250ABugReports%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%252Fissues%250ADepends%253A%2520%250A%2520%2520%2520%2520R%2520(%253E%253D%25203.2.0)%250AImports%253A%2520%250A%2520%2520%2520%2520clipr%252C%250A%2520%2520%2520%2520details%252C%250A%2520%2520%2520%2520httpuv%252C%250A%2520%2520%2520%2520httr%252C%250A%2520%2520%2520%2520magick%252C%250A%2520%2520%2520%2520R6%252C%250A%2520%2520%2520%2520reprex%252C%250A%2520%2520%2520%2520RSelenium%252C%250A%2520%2520%2520%2520rtweet%252C%250A%2520%2520%2520%2520utils%252C%250A%2520%2520%2520%2520wdman%252C%250A%2520%2520%2520%2520jsonlite%252C%250A%2520%2520%2520%2520yaml%250ASuggests%253A%2520%250A%2520%2520%2520%2520covr%252C%250A%2520%2520%2520%2520knitr%252C%250A%2520%2520%2520%2520rmarkdown%252C%250A%2520%2520%2520%2520testthat%250AVignetteBuilder%253A%2520%250A%2520%2520%2520%2520knitr%250ARdMacros%253A%2520%250A%2520%2520%2520%2520details%250AEncoding%253A%2520UTF-8%250ALazyData%253A%2520true%250ARoxygen%253A%2520list(markdown%2520%253D%2520TRUE%252Cold_usage%2520%253D%2520TRUE%252Cr6%2520%253D%2520FALSE)%250ARoxygenNote%253A%25207.2.1"
Click the link to see the URI works.
Manipulate carbon object
Aesthetics of the carbon object that can be manipulated
Carbon Variable
Carbonate Variable
Description
Default
l
language
language
r
bg
palette
layout pallete (vector with c(r,g,b,a)
c(r=171,g=184,b=195,a=1)
t
template
layout template (listed in get_templates())
‘seti’
wc
add_window_control
add/remove window controls (circles on top left corner)
TRUE
wt
window_control_theme
change window control themes (listed in get_windows_control_themes())
‘none’
ds
add_drop_shadow
add/remove dropshadow
TRUE
dsyoff
drop_shadow_offset_y
shadow vertical offset (px)
20
dsblur
drop_shadow_blur_radius
shadow blur radius (px)
68
wa
auto_adjust_width
auto-audjust output width
TRUE
pv
padding_vertical
vertical padding (px)
48
ph
padding_horizontal
horizontal padding (px)
32
ln
add_line_number
add/remove line numbers
FALSE
fm
font_family
layout font family (listed in get_font_families())
‘Hack’
fs
font_size
font size (px)
14
lh
line_height_percent
relative space between lines (percent)
133
si
square_image
output image is square
FALSE
es
relative_export_size
image size in export relative to what is in the preview (1,2 or 4)
1
wm
add_watermark
add official carbon.js watermark
FALSE
x$get_templates()
#> [1] "3024-night" "a11y-dark" "blackboard"
#> [4] "base16-dark" "base16-light" "cobalt"
#> [7] "dracula" "duotone-dark" "hopscotch"
#> [10] "lucario" "material" "monokai"
#> [13] "night-owl" "nord" "oceanic-next"
#> [16] "one-light" "one-dark" "panda-syntax"
#> [19] "paraiso-dark" "seti" "shades-of-purple"
#> [22] "solarized dark" "solarized light" "synthwave-84"
#> [25] "twilight" "verminal" "vscode"
#> [28] "yeti" "zenburn"
x$get_font_families()
#> [1] "Anonymous Pro" "Cascadia Code" "Droid Sans Mono"
#> [4] "Fantasque Sans Mono" "Fira Code" "Hack"
#> [7] "IBM Plex Mono" "Inconsolata" "JetBrains Mono"
#> [10] "Monoid" "Source Code Pro" "Space Mono"
#> [13] "Ubuntu Mono"
x$get_windows_control_themes()
#> [1] "none" "sharp" "bw"
Personal Configuration
Users can use a file called carbon.yml and place it in their home directory (~) to override the packages defaults in order to create a session peristent carbon template they like. The config file controls all the public carbon object fields. The following is an example of such a configuration file.
These fields will set
- The palette (rgba)
g and a fields to 175 and 0.7 respectively
- The template will be set to
panda-syntax
- The font to
Fira Code
- The padding around the output will be made tighter than the system defaults 11px and 14px.
palette:
- g: 175.0
- a: 0.7
template: panda-syntax
font_family: Fira Code
padding_vertical: 11
padding_horizontal: 14
Set the download directory
x$download_path <- file.path('README_files/download')
Carbonate code directly to file
This function depends on RSelenium
x$carbonate(file = 'myfile.png')
x$template <-'cobalt'
x$carbonate(file = 'new_template.png')
x$font_family <-'IBM Plex Mono'
x$carbonate(file = 'new_font.png')
Sharing
Tinyurl
You can also put a tinyurl link as a watermark on the image produced that will open to the carbon.now.sh page that has the code in the image.
x$add_tinyurl <- TRUE
x$carbonate(file = 'tiny_url.png')
If you just want the tinyurl link without the image to use in a tweet you can create it using
x$tiny()
#> [1] "https://tinyurl.com/2kvjyzlx"
Or you can put the link directly on your clipboard
x$tiny(clip = TRUE)
#> [1] "https://tinyurl.com/2kvjyzlx"
clipr::read_clip()
#> [1] "https://tinyurl.com/2kvjyzlx"
Twitter
Direct
You can also directly tweet the image. An automatic status is created with two options
- Default
- Created in R using the Carbonate 📦
- When
add_tinyurl <- TRUE
- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx
- Manual
- Using
tweet_status you can write your own status.
x <- carbonate::carbon$new()
x$tweet <- TRUE
x$carbonate()
Post process (Batch)
If you have images stored in x$carbons you can post them also in a tweet using.
# for multiple png attachments
x$rtweet(x$carbons,media_type = 'png') #using default status
# subsets of images
x$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')
# for gifs
x$rtweet(status='This is a gif', x$carbons,media_type = 'gif')
Post image processing
All carbon outputs are collected and saved in the list x$carbons
Combining
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append()
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append(stack = TRUE)
================================================
FILE: docs/pkgdown.css
================================================
/* Sticky footer */
/**
* Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
* Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
*
* .Site -> body > .container
* .Site-content -> body > .container .row
* .footer -> footer
*
* Key idea seems to be to ensure that .container and __all its parents__
* have height set to 100%
*
*/
html, body {
height: 100%;
}
body {
position: relative;
}
body > .container {
display: flex;
height: 100%;
flex-direction: column;
}
body > .container .row {
flex: 1 0 auto;
}
footer {
margin-top: 45px;
padding: 35px 0 36px;
border-top: 1px solid #e5e5e5;
color: #666;
display: flex;
flex-shrink: 0;
}
footer p {
margin-bottom: 0;
}
footer div {
flex: 1;
}
footer .pkgdown {
text-align: right;
}
footer p {
margin-bottom: 0;
}
img.icon {
float: right;
}
/* Ensure in-page images don't run outside their container */
.contents img {
max-width: 100%;
height: auto;
}
/* Fix bug in bootstrap (only seen in firefox) */
summary {
display: list-item;
}
/* Typographic tweaking ---------------------------------*/
.contents .page-header {
margin-top: calc(-60px + 1em);
}
dd {
margin-left: 3em;
}
/* Section anchors ---------------------------------*/
a.anchor {
display: none;
margin-left: 5px;
width: 20px;
height: 20px;
background-image: url(./link.svg);
background-repeat: no-repeat;
background-size: 20px 20px;
background-position: center center;
}
h1:hover .anchor,
h2:hover .anchor,
h3:hover .anchor,
h4:hover .anchor,
h5:hover .anchor,
h6:hover .anchor {
display: inline-block;
}
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
padding-top: 60px;
margin-top: -40px;
}
/* Navbar submenu --------------------------*/
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #ffffff;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
/* Sidebar --------------------------*/
#pkgdown-sidebar {
margin-top: 30px;
position: -webkit-sticky;
position: sticky;
top: 70px;
}
#pkgdown-sidebar h2 {
font-size: 1.5em;
margin-top: 1em;
}
#pkgdown-sidebar h2:first-child {
margin-top: 0;
}
#pkgdown-sidebar .list-unstyled li {
margin-bottom: 0.5em;
}
/* bootstrap-toc tweaks ------------------------------------------------------*/
/* All levels of nav */
nav[data-toggle='toc'] .nav > li > a {
padding: 4px 20px 4px 6px;
font-size: 1.5rem;
font-weight: 400;
color: inherit;
}
nav[data-toggle='toc'] .nav > li > a:hover,
nav[data-toggle='toc'] .nav > li > a:focus {
padding-left: 5px;
color: inherit;
border-left: 1px solid #878787;
}
nav[data-toggle='toc'] .nav > .active > a,
nav[data-toggle='toc'] .nav > .active:hover > a,
nav[data-toggle='toc'] .nav > .active:focus > a {
padding-left: 5px;
font-size: 1.5rem;
font-weight: 400;
color: inherit;
border-left: 2px solid #878787;
}
/* Nav: second level (shown on .active) */
nav[data-toggle='toc'] .nav .nav {
display: none; /* Hide by default, but at >768px, show it */
padding-bottom: 10px;
}
nav[data-toggle='toc'] .nav .nav > li > a {
padding-left: 16px;
font-size: 1.35rem;
}
nav[data-toggle='toc'] .nav .nav > li > a:hover,
nav[data-toggle='toc'] .nav .nav > li > a:focus {
padding-left: 15px;
}
nav[data-toggle='toc'] .nav .nav > .active > a,
nav[data-toggle='toc'] .nav .nav > .active:hover > a,
nav[data-toggle='toc'] .nav .nav > .active:focus > a {
padding-left: 15px;
font-weight: 500;
font-size: 1.35rem;
}
/* orcid ------------------------------------------------------------------- */
.orcid {
font-size: 16px;
color: #A6CE39;
/* margins are required by official ORCID trademark and display guidelines */
margin-left:4px;
margin-right:4px;
vertical-align: middle;
}
/* Reference index & topics ----------------------------------------------- */
.ref-index th {font-weight: normal;}
.ref-index td {vertical-align: top; min-width: 100px}
.ref-index .icon {width: 40px;}
.ref-index .alias {width: 40%;}
.ref-index-icons .alias {width: calc(40% - 40px);}
.ref-index .title {width: 60%;}
.ref-arguments th {text-align: right; padding-right: 10px;}
.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
.ref-arguments .name {width: 20%;}
.ref-arguments .desc {width: 80%;}
/* Nice scrolling for wide elements --------------------------------------- */
table {
display: block;
overflow: auto;
}
/* Syntax highlighting ---------------------------------------------------- */
pre, code, pre code {
background-color: #f8f8f8;
color: #333;
}
pre, pre code {
white-space: pre-wrap;
word-break: break-all;
overflow-wrap: break-word;
}
pre {
border: 1px solid #eee;
}
pre .img, pre .r-plt {
margin: 5px 0;
}
pre .img img, pre .r-plt img {
background-color: #fff;
}
code a, pre a {
color: #375f84;
}
a.sourceLine:hover {
text-decoration: none;
}
.fl {color: #1514b5;}
.fu {color: #000000;} /* function */
.ch,.st {color: #036a07;} /* string */
.kw {color: #264D66;} /* keyword */
.co {color: #888888;} /* comment */
.error {font-weight: bolder;}
.warning {font-weight: bolder;}
/* Clipboard --------------------------*/
.hasCopyButton {
position: relative;
}
.btn-copy-ex {
position: absolute;
right: 0;
top: 0;
visibility: hidden;
}
.hasCopyButton:hover button.btn-copy-ex {
visibility: visible;
}
/* headroom.js ------------------------ */
.headroom {
will-change: transform;
transition: transform 200ms linear;
}
.headroom--pinned {
transform: translateY(0%);
}
.headroom--unpinned {
transform: translateY(-100%);
}
/* mark.js ----------------------------*/
mark {
background-color: rgba(255, 255, 51, 0.5);
border-bottom: 2px solid rgba(255, 153, 51, 0.3);
padding: 1px;
}
/* vertical spacing after htmlwidgets */
.html-widget {
margin-bottom: 10px;
}
/* fontawesome ------------------------ */
.fab {
font-family: "Font Awesome 5 Brands" !important;
}
/* don't display links in code chunks when printing */
/* source: https://stackoverflow.com/a/10781533 */
@media print {
code a:link:after, code a:visited:after {
content: "";
}
}
/* Section anchors ---------------------------------
Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
*/
div.csl-bib-body { }
div.csl-entry {
clear: both;
}
.hanging-indent div.csl-entry {
margin-left:2em;
text-indent:-2em;
}
div.csl-left-margin {
min-width:2em;
float:left;
}
div.csl-right-inline {
margin-left:2em;
padding-left:1em;
}
div.csl-indent {
margin-left: 2em;
}
================================================
FILE: docs/pkgdown.js
================================================
/* http://gregfranko.com/blog/jquery-best-practices/ */
(function($) {
$(function() {
$('.navbar-fixed-top').headroom();
$('body').css('padding-top', $('.navbar').height() + 10);
$(window).resize(function(){
$('body').css('padding-top', $('.navbar').height() + 10);
});
$('[data-toggle="tooltip"]').tooltip();
var cur_path = paths(location.pathname);
var links = $("#navbar ul li a");
var max_length = -1;
var pos = -1;
for (var i = 0; i < links.length; i++) {
if (links[i].getAttribute("href") === "#")
continue;
// Ignore external links
if (links[i].host !== location.host)
continue;
var nav_path = paths(links[i].pathname);
var length = prefix_length(nav_path, cur_path);
if (length > max_length) {
max_length = length;
pos = i;
}
}
// Add class to parent
`).
getTopLevel: function($scope) {
for (var i = 1; i <= 6; i++) {
var $headings = this.findOrFilter($scope, 'h' + i);
if ($headings.length > 1) {
return i;
}
}
return 1;
},
// returns the elements for the top level, and the next below it
getHeadings: function($scope, topLevel) {
var topSelector = 'h' + topLevel;
var secondaryLevel = topLevel + 1;
var secondarySelector = 'h' + secondaryLevel;
return this.findOrFilter($scope, topSelector + ',' + secondarySelector);
},
getNavLevel: function(el) {
return parseInt(el.tagName.charAt(1), 10);
},
populateNav: function($topContext, topLevel, $headings) {
var $context = $topContext;
var $prevNav;
var helpers = this;
$headings.each(function(i, el) {
var $newNav = helpers.generateNavItem(el);
var navLevel = helpers.getNavLevel(el);
// determine the proper $context
if (navLevel === topLevel) {
// use top level
$context = $topContext;
} else if ($prevNav && $context === $topContext) {
// create a new level of the tree and switch to it
$context = helpers.createChildNavList($prevNav);
} // else use the current $context
$context.append($newNav);
$prevNav = $newNav;
});
},
parseOps: function(arg) {
var opts;
if (arg.jquery) {
opts = {
$nav: arg
};
} else {
opts = arg;
}
opts.$scope = opts.$scope || $(document.body);
return opts;
}
},
// accepts a jQuery object, or an options object
init: function(opts) {
opts = this.helpers.parseOps(opts);
// ensure that the data attribute is in place for styling
opts.$nav.attr('data-toggle', 'toc');
var $topContext = this.helpers.createChildNavList(opts.$nav);
var topLevel = this.helpers.getTopLevel(opts.$scope);
var $headings = this.helpers.getHeadings(opts.$scope, topLevel);
this.helpers.populateNav($topContext, topLevel, $headings);
}
};
$(function() {
$('nav[data-toggle="toc"]').each(function(i, el) {
var $nav = $(el);
Toc.init($nav);
});
});
})();
================================================
FILE: docs/docsearch.css
================================================
/* Docsearch -------------------------------------------------------------- */
/*
Source: https://github.com/algolia/docsearch/
License: MIT
*/
.algolia-autocomplete {
display: block;
-webkit-box-flex: 1;
-ms-flex: 1;
flex: 1
}
.algolia-autocomplete .ds-dropdown-menu {
width: 100%;
min-width: none;
max-width: none;
padding: .75rem 0;
background-color: #fff;
background-clip: padding-box;
border: 1px solid rgba(0, 0, 0, .1);
box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);
}
@media (min-width:768px) {
.algolia-autocomplete .ds-dropdown-menu {
width: 175%
}
}
.algolia-autocomplete .ds-dropdown-menu::before {
display: none
}
.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {
padding: 0;
background-color: rgb(255,255,255);
border: 0;
max-height: 80vh;
}
.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {
margin-top: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion {
padding: 0;
overflow: visible
}
.algolia-autocomplete .algolia-docsearch-suggestion--category-header {
padding: .125rem 1rem;
margin-top: 0;
font-size: 1.3em;
font-weight: 500;
color: #00008B;
border-bottom: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {
float: none;
padding-top: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {
float: none;
width: auto;
padding: 0;
text-align: left
}
.algolia-autocomplete .algolia-docsearch-suggestion--content {
float: none;
width: auto;
padding: 0
}
.algolia-autocomplete .algolia-docsearch-suggestion--content::before {
display: none
}
.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {
padding-top: .75rem;
margin-top: .75rem;
border-top: 1px solid rgba(0, 0, 0, .1)
}
.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {
display: block;
padding: .1rem 1rem;
margin-bottom: 0.1;
font-size: 1.0em;
font-weight: 400
/* display: none */
}
.algolia-autocomplete .algolia-docsearch-suggestion--title {
display: block;
padding: .25rem 1rem;
margin-bottom: 0;
font-size: 0.9em;
font-weight: 400
}
.algolia-autocomplete .algolia-docsearch-suggestion--text {
padding: 0 1rem .5rem;
margin-top: -.25rem;
font-size: 0.8em;
font-weight: 400;
line-height: 1.25
}
.algolia-autocomplete .algolia-docsearch-footer {
width: 110px;
height: 20px;
z-index: 3;
margin-top: 10.66667px;
float: right;
font-size: 0;
line-height: 0;
}
.algolia-autocomplete .algolia-docsearch-footer--logo {
background-image: url("data:image/svg+xml;utf8,");
background-repeat: no-repeat;
background-position: 50%;
background-size: 100%;
overflow: hidden;
text-indent: -9000px;
width: 100%;
height: 100%;
display: block;
transform: translate(-8px);
}
.algolia-autocomplete .algolia-docsearch-suggestion--highlight {
color: #FF8C00;
background: rgba(232, 189, 54, 0.1)
}
.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {
box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)
}
.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {
background-color: rgba(192, 192, 192, .15)
}
================================================
FILE: docs/docsearch.js
================================================
$(function() {
// register a handler to move the focus to the search bar
// upon pressing shift + "/" (i.e. "?")
$(document).on('keydown', function(e) {
if (e.shiftKey && e.keyCode == 191) {
e.preventDefault();
$("#search-input").focus();
}
});
$(document).ready(function() {
// do keyword highlighting
/* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */
var mark = function() {
var referrer = document.URL ;
var paramKey = "q" ;
if (referrer.indexOf("?") !== -1) {
var qs = referrer.substr(referrer.indexOf('?') + 1);
var qs_noanchor = qs.split('#')[0];
var qsa = qs_noanchor.split('&');
var keyword = "";
for (var i = 0; i < qsa.length; i++) {
var currentParam = qsa[i].split('=');
if (currentParam.length !== 2) {
continue;
}
if (currentParam[0] == paramKey) {
keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20"));
}
}
if (keyword !== "") {
$(".contents").unmark({
done: function() {
$(".contents").mark(keyword);
}
});
}
}
};
mark();
});
});
/* Search term highlighting ------------------------------*/
function matchedWords(hit) {
var words = [];
var hierarchy = hit._highlightResult.hierarchy;
// loop to fetch from lvl0, lvl1, etc.
for (var idx in hierarchy) {
words = words.concat(hierarchy[idx].matchedWords);
}
var content = hit._highlightResult.content;
if (content) {
words = words.concat(content.matchedWords);
}
// return unique words
var words_uniq = [...new Set(words)];
return words_uniq;
}
function updateHitURL(hit) {
var words = matchedWords(hit);
var url = "";
if (hit.anchor) {
url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor;
} else {
url = hit.url + '?q=' + escape(words.join(" "));
}
return url;
}
================================================
FILE: docs/index.html
================================================
Interact with carbon.js • carbonate
“carbon.js is the easiest way to create beautiful images of your source code.”
This package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
Like the image below:
Installation
#remotes::install_github('yonicd/carbonate')
install.packages('carbonate')
Usage
Initialize new carbon object
The default code in the carbon object is taken from the clipboard.
x <- carbon$new()
But can also be defined inline. Code can be a character object of any length.
The code is kept in the object and can be changed at any time.
x$code
#> [1] "Package: carbonate"
#> [2] "Title: Interact with 'carbon.js'"
#> [3] "Version: 0.2.0"
#> [4] "Authors@R: "
#> [5] " person(given = \"Jonathan\","
#> [6] " family = \"Sidi\","
#> [7] " role = c(\"aut\", \"cre\"),"
#> [8] " email = \"yonicd@gmail.com\","
#> [9] " comment = c(ORCID = \"0000-0002-4222-1819\"))"
#> [10] "Description: Create beautiful images of source code using"
#> [11] " 'carbon.js'<https://carbon.now.sh/about>."
#> [12] "License: MIT + file LICENSE"
#> [13] "URL: https://github.com/yonicd/carbonate"
#> [14] "BugReports: https://github.com/yonicd/carbonate/issues"
#> [15] "Depends: "
#> [16] " R (>= 3.2.0)"
#> [17] "Imports: "
#> [18] " clipr,"
#> [19] " details,"
#> [20] " httpuv,"
#> [21] " httr,"
#> [22] " magick,"
#> [23] " R6,"
#> [24] " reprex,"
#> [25] " RSelenium,"
#> [26] " rtweet,"
#> [27] " utils,"
#> [28] " wdman,"
#> [29] " jsonlite,"
#> [30] " yaml"
#> [31] "Suggests: "
#> [32] " covr,"
#> [33] " knitr,"
#> [34] " rmarkdown,"
#> [35] " testthat"
#> [36] "VignetteBuilder: "
#> [37] " knitr"
#> [38] "RdMacros: "
#> [39] " details"
#> [40] "Encoding: UTF-8"
#> [41] "LazyData: true"
#> [42] "Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)"
#> [43] "RoxygenNote: 7.2.1"
The main job of the R6 object is to convert all the options into a uri that is sent to the carbon url page, where it is processed.
x$uri()
#> [1] "https://carbon.now.sh/?bg=rgba(171%2C175%2C195%2C0.7)&t=panda-syntax&wt=none&l=r&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=11px&ph=14px&ln=false&fm=Fira%20Code&fs=14px&lh=133%25&si=false&es=1x&wm=false&ts=false&code=Package%253A%2520carbonate%250ATitle%253A%2520Interact%2520with%2520%27carbon.js%27%250AVersion%253A%25200.2.0%250AAuthors%2540R%253A%2520%250A%2520%2520%2520%2520person(given%2520%253D%2520%2522Jonathan%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520family%2520%253D%2520%2522Sidi%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520role%2520%253D%2520c(%2522aut%2522%252C%2520%2522cre%2522)%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520email%2520%253D%2520%2522yonicd%2540gmail.com%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520comment%2520%253D%2520c(ORCID%2520%253D%2520%25220000-0002-4222-1819%2522))%250ADescription%253A%2520Create%2520beautiful%2520images%2520of%2520source%2520code%2520using%250A%2520%2520%2520%2520%27carbon.js%27%253Chttps%253A%252F%252Fcarbon.now.sh%252Fabout%253E.%250ALicense%253A%2520MIT%2520%252B%2520file%2520LICENSE%250AURL%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%250ABugReports%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%252Fissues%250ADepends%253A%2520%250A%2520%2520%2520%2520R%2520(%253E%253D%25203.2.0)%250AImports%253A%2520%250A%2520%2520%2520%2520clipr%252C%250A%2520%2520%2520%2520details%252C%250A%2520%2520%2520%2520httpuv%252C%250A%2520%2520%2520%2520httr%252C%250A%2520%2520%2520%2520magick%252C%250A%2520%2520%2520%2520R6%252C%250A%2520%2520%2520%2520reprex%252C%250A%2520%2520%2520%2520RSelenium%252C%250A%2520%2520%2520%2520rtweet%252C%250A%2520%2520%2520%2520utils%252C%250A%2520%2520%2520%2520wdman%252C%250A%2520%2520%2520%2520jsonlite%252C%250A%2520%2520%2520%2520yaml%250ASuggests%253A%2520%250A%2520%2520%2520%2520covr%252C%250A%2520%2520%2520%2520knitr%252C%250A%2520%2520%2520%2520rmarkdown%252C%250A%2520%2520%2520%2520testthat%250AVignetteBuilder%253A%2520%250A%2520%2520%2520%2520knitr%250ARdMacros%253A%2520%250A%2520%2520%2520%2520details%250AEncoding%253A%2520UTF-8%250ALazyData%253A%2520true%250ARoxygen%253A%2520list(markdown%2520%253D%2520TRUE%252Cold_usage%2520%253D%2520TRUE%252Cr6%2520%253D%2520FALSE)%250ARoxygenNote%253A%25207.2.1"
Click the link to see the URI works.
Manipulate carbon object
Aesthetics of the carbon object that can be manipulated
Carbon Variable
Carbonate Variable
Description
Default
l
language
language
r
bg
palette
layout pallete (vector with c(r,g,b,a)
c(r=171,g=184,b=195,a=1)
t
template
layout template (listed in get_templates())
‘seti’
wc
add_window_control
add/remove window controls (circles on top left corner)
TRUE
wt
window_control_theme
change window control themes (listed in get_windows_control_themes())
‘none’
ds
add_drop_shadow
add/remove dropshadow
TRUE
dsyoff
drop_shadow_offset_y
shadow vertical offset (px)
20
dsblur
drop_shadow_blur_radius
shadow blur radius (px)
68
wa
auto_adjust_width
auto-audjust output width
TRUE
pv
padding_vertical
vertical padding (px)
48
ph
padding_horizontal
horizontal padding (px)
32
ln
add_line_number
add/remove line numbers
FALSE
fm
font_family
layout font family (listed in get_font_families())
‘Hack’
fs
font_size
font size (px)
14
lh
line_height_percent
relative space between lines (percent)
133
si
square_image
output image is square
FALSE
es
relative_export_size
image size in export relative to what is in the preview (1,2 or 4)
1
wm
add_watermark
add official carbon.js watermark
FALSE
x$get_templates()
#> [1] "3024-night" "a11y-dark" "blackboard"
#> [4] "base16-dark" "base16-light" "cobalt"
#> [7] "dracula" "duotone-dark" "hopscotch"
#> [10] "lucario" "material" "monokai"
#> [13] "night-owl" "nord" "oceanic-next"
#> [16] "one-light" "one-dark" "panda-syntax"
#> [19] "paraiso-dark" "seti" "shades-of-purple"
#> [22] "solarized dark" "solarized light" "synthwave-84"
#> [25] "twilight" "verminal" "vscode"
#> [28] "yeti" "zenburn"
x$get_font_families()
#> [1] "Anonymous Pro" "Cascadia Code" "Droid Sans Mono"
#> [4] "Fantasque Sans Mono" "Fira Code" "Hack"
#> [7] "IBM Plex Mono" "Inconsolata" "JetBrains Mono"
#> [10] "Monoid" "Source Code Pro" "Space Mono"
#> [13] "Ubuntu Mono"
x$get_windows_control_themes()
#> [1] "none" "sharp" "bw"
Personal Configuration
Users can use a file called carbon.yml and place it in their home directory (~) to override the packages defaults in order to create a session peristent carbon template they like. The config file controls all the public carbon object fields. The following is an example of such a configuration file.
These fields will set
- The palette (rgba)
g and a fields to 175 and 0.7 respectively
- The template will be set to
panda-syntax
- The font to
Fira Code
- The padding around the output will be made tighter than the system defaults 11px and 14px.
palette:
- g: 175.0
- a: 0.7
template: panda-syntax
font_family: Fira Code
padding_vertical: 11
padding_horizontal: 14
Set the download directory
x$download_path <- file.path('README_files/download')
Carbonate code directly to file
This function depends on RSelenium
x$carbonate(file = 'myfile.png')
x$template <-'cobalt'
x$carbonate(file = 'new_template.png')
x$font_family <-'IBM Plex Mono'
x$carbonate(file = 'new_font.png')
Sharing
Tinyurl
You can also put a tinyurl link as a watermark on the image produced that will open to the carbon.now.sh page that has the code in the image.
x$add_tinyurl <- TRUE
x$carbonate(file = 'tiny_url.png')
If you just want the tinyurl link without the image to use in a tweet you can create it using
x$tiny()
#> [1] "https://tinyurl.com/2kvjyzlx"
Or you can put the link directly on your clipboard
x$tiny(clip = TRUE)
#> [1] "https://tinyurl.com/2kvjyzlx"
clipr::read_clip()
#> [1] "https://tinyurl.com/2kvjyzlx"
Twitter
Direct
You can also directly tweet the image. An automatic status is created with two options
- Default
- Created in R using the Carbonate 📦
- When
add_tinyurl <- TRUE
- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx
- Manual
- Using
tweet_status you can write your own status.
x <- carbonate::carbon$new()
x$tweet <- TRUE
x$carbonate()
Post process (Batch)
If you have images stored in x$carbons you can post them also in a tweet using.
# for multiple png attachments
x$rtweet(x$carbons,media_type = 'png') #using default status
# subsets of images
x$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')
# for gifs
x$rtweet(status='This is a gif', x$carbons,media_type = 'gif')
Post image processing
All carbon outputs are collected and saved in the list x$carbons
Combining
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append()
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append(stack = TRUE)
================================================
FILE: docs/pkgdown.css
================================================
/* Sticky footer */
/**
* Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/
* Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css
*
* .Site -> body > .container
* .Site-content -> body > .container .row
* .footer -> footer
*
* Key idea seems to be to ensure that .container and __all its parents__
* have height set to 100%
*
*/
html, body {
height: 100%;
}
body {
position: relative;
}
body > .container {
display: flex;
height: 100%;
flex-direction: column;
}
body > .container .row {
flex: 1 0 auto;
}
footer {
margin-top: 45px;
padding: 35px 0 36px;
border-top: 1px solid #e5e5e5;
color: #666;
display: flex;
flex-shrink: 0;
}
footer p {
margin-bottom: 0;
}
footer div {
flex: 1;
}
footer .pkgdown {
text-align: right;
}
footer p {
margin-bottom: 0;
}
img.icon {
float: right;
}
/* Ensure in-page images don't run outside their container */
.contents img {
max-width: 100%;
height: auto;
}
/* Fix bug in bootstrap (only seen in firefox) */
summary {
display: list-item;
}
/* Typographic tweaking ---------------------------------*/
.contents .page-header {
margin-top: calc(-60px + 1em);
}
dd {
margin-left: 3em;
}
/* Section anchors ---------------------------------*/
a.anchor {
display: none;
margin-left: 5px;
width: 20px;
height: 20px;
background-image: url(./link.svg);
background-repeat: no-repeat;
background-size: 20px 20px;
background-position: center center;
}
h1:hover .anchor,
h2:hover .anchor,
h3:hover .anchor,
h4:hover .anchor,
h5:hover .anchor,
h6:hover .anchor {
display: inline-block;
}
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
padding-top: 60px;
margin-top: -40px;
}
/* Navbar submenu --------------------------*/
.dropdown-submenu {
position: relative;
}
.dropdown-submenu>.dropdown-menu {
top: 0;
left: 100%;
margin-top: -6px;
margin-left: -1px;
border-radius: 0 6px 6px 6px;
}
.dropdown-submenu:hover>.dropdown-menu {
display: block;
}
.dropdown-submenu>a:after {
display: block;
content: " ";
float: right;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
border-width: 5px 0 5px 5px;
border-left-color: #cccccc;
margin-top: 5px;
margin-right: -10px;
}
.dropdown-submenu:hover>a:after {
border-left-color: #ffffff;
}
.dropdown-submenu.pull-left {
float: none;
}
.dropdown-submenu.pull-left>.dropdown-menu {
left: -100%;
margin-left: 10px;
border-radius: 6px 0 6px 6px;
}
/* Sidebar --------------------------*/
#pkgdown-sidebar {
margin-top: 30px;
position: -webkit-sticky;
position: sticky;
top: 70px;
}
#pkgdown-sidebar h2 {
font-size: 1.5em;
margin-top: 1em;
}
#pkgdown-sidebar h2:first-child {
margin-top: 0;
}
#pkgdown-sidebar .list-unstyled li {
margin-bottom: 0.5em;
}
/* bootstrap-toc tweaks ------------------------------------------------------*/
/* All levels of nav */
nav[data-toggle='toc'] .nav > li > a {
padding: 4px 20px 4px 6px;
font-size: 1.5rem;
font-weight: 400;
color: inherit;
}
nav[data-toggle='toc'] .nav > li > a:hover,
nav[data-toggle='toc'] .nav > li > a:focus {
padding-left: 5px;
color: inherit;
border-left: 1px solid #878787;
}
nav[data-toggle='toc'] .nav > .active > a,
nav[data-toggle='toc'] .nav > .active:hover > a,
nav[data-toggle='toc'] .nav > .active:focus > a {
padding-left: 5px;
font-size: 1.5rem;
font-weight: 400;
color: inherit;
border-left: 2px solid #878787;
}
/* Nav: second level (shown on .active) */
nav[data-toggle='toc'] .nav .nav {
display: none; /* Hide by default, but at >768px, show it */
padding-bottom: 10px;
}
nav[data-toggle='toc'] .nav .nav > li > a {
padding-left: 16px;
font-size: 1.35rem;
}
nav[data-toggle='toc'] .nav .nav > li > a:hover,
nav[data-toggle='toc'] .nav .nav > li > a:focus {
padding-left: 15px;
}
nav[data-toggle='toc'] .nav .nav > .active > a,
nav[data-toggle='toc'] .nav .nav > .active:hover > a,
nav[data-toggle='toc'] .nav .nav > .active:focus > a {
padding-left: 15px;
font-weight: 500;
font-size: 1.35rem;
}
/* orcid ------------------------------------------------------------------- */
.orcid {
font-size: 16px;
color: #A6CE39;
/* margins are required by official ORCID trademark and display guidelines */
margin-left:4px;
margin-right:4px;
vertical-align: middle;
}
/* Reference index & topics ----------------------------------------------- */
.ref-index th {font-weight: normal;}
.ref-index td {vertical-align: top; min-width: 100px}
.ref-index .icon {width: 40px;}
.ref-index .alias {width: 40%;}
.ref-index-icons .alias {width: calc(40% - 40px);}
.ref-index .title {width: 60%;}
.ref-arguments th {text-align: right; padding-right: 10px;}
.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}
.ref-arguments .name {width: 20%;}
.ref-arguments .desc {width: 80%;}
/* Nice scrolling for wide elements --------------------------------------- */
table {
display: block;
overflow: auto;
}
/* Syntax highlighting ---------------------------------------------------- */
pre, code, pre code {
background-color: #f8f8f8;
color: #333;
}
pre, pre code {
white-space: pre-wrap;
word-break: break-all;
overflow-wrap: break-word;
}
pre {
border: 1px solid #eee;
}
pre .img, pre .r-plt {
margin: 5px 0;
}
pre .img img, pre .r-plt img {
background-color: #fff;
}
code a, pre a {
color: #375f84;
}
a.sourceLine:hover {
text-decoration: none;
}
.fl {color: #1514b5;}
.fu {color: #000000;} /* function */
.ch,.st {color: #036a07;} /* string */
.kw {color: #264D66;} /* keyword */
.co {color: #888888;} /* comment */
.error {font-weight: bolder;}
.warning {font-weight: bolder;}
/* Clipboard --------------------------*/
.hasCopyButton {
position: relative;
}
.btn-copy-ex {
position: absolute;
right: 0;
top: 0;
visibility: hidden;
}
.hasCopyButton:hover button.btn-copy-ex {
visibility: visible;
}
/* headroom.js ------------------------ */
.headroom {
will-change: transform;
transition: transform 200ms linear;
}
.headroom--pinned {
transform: translateY(0%);
}
.headroom--unpinned {
transform: translateY(-100%);
}
/* mark.js ----------------------------*/
mark {
background-color: rgba(255, 255, 51, 0.5);
border-bottom: 2px solid rgba(255, 153, 51, 0.3);
padding: 1px;
}
/* vertical spacing after htmlwidgets */
.html-widget {
margin-bottom: 10px;
}
/* fontawesome ------------------------ */
.fab {
font-family: "Font Awesome 5 Brands" !important;
}
/* don't display links in code chunks when printing */
/* source: https://stackoverflow.com/a/10781533 */
@media print {
code a:link:after, code a:visited:after {
content: "";
}
}
/* Section anchors ---------------------------------
Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71
*/
div.csl-bib-body { }
div.csl-entry {
clear: both;
}
.hanging-indent div.csl-entry {
margin-left:2em;
text-indent:-2em;
}
div.csl-left-margin {
min-width:2em;
float:left;
}
div.csl-right-inline {
margin-left:2em;
padding-left:1em;
}
div.csl-indent {
margin-left: 2em;
}
================================================
FILE: docs/pkgdown.js
================================================
/* http://gregfranko.com/blog/jquery-best-practices/ */
(function($) {
$(function() {
$('.navbar-fixed-top').headroom();
$('body').css('padding-top', $('.navbar').height() + 10);
$(window).resize(function(){
$('body').css('padding-top', $('.navbar').height() + 10);
});
$('[data-toggle="tooltip"]').tooltip();
var cur_path = paths(location.pathname);
var links = $("#navbar ul li a");
var max_length = -1;
var pos = -1;
for (var i = 0; i < links.length; i++) {
if (links[i].getAttribute("href") === "#")
continue;
// Ignore external links
if (links[i].host !== location.host)
continue;
var nav_path = paths(links[i].pathname);
var length = prefix_length(nav_path, cur_path);
if (length > max_length) {
max_length = length;
pos = i;
}
}
// Add class to parent
“carbon.js is the easiest way to create beautiful images of your source code.”
This package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
Like the image below:
Installation
#remotes::install_github('yonicd/carbonate')
install.packages('carbonate')Usage
Initialize new carbon object
The default code in the carbon object is taken from the clipboard.
x <- carbon$new()But can also be defined inline. Code can be a character object of any length.
The code is kept in the object and can be changed at any time.
x$code
#> [1] "Package: carbonate"
#> [2] "Title: Interact with 'carbon.js'"
#> [3] "Version: 0.2.0"
#> [4] "Authors@R: "
#> [5] " person(given = \"Jonathan\","
#> [6] " family = \"Sidi\","
#> [7] " role = c(\"aut\", \"cre\"),"
#> [8] " email = \"yonicd@gmail.com\","
#> [9] " comment = c(ORCID = \"0000-0002-4222-1819\"))"
#> [10] "Description: Create beautiful images of source code using"
#> [11] " 'carbon.js'<https://carbon.now.sh/about>."
#> [12] "License: MIT + file LICENSE"
#> [13] "URL: https://github.com/yonicd/carbonate"
#> [14] "BugReports: https://github.com/yonicd/carbonate/issues"
#> [15] "Depends: "
#> [16] " R (>= 3.2.0)"
#> [17] "Imports: "
#> [18] " clipr,"
#> [19] " details,"
#> [20] " httpuv,"
#> [21] " httr,"
#> [22] " magick,"
#> [23] " R6,"
#> [24] " reprex,"
#> [25] " RSelenium,"
#> [26] " rtweet,"
#> [27] " utils,"
#> [28] " wdman,"
#> [29] " jsonlite,"
#> [30] " yaml"
#> [31] "Suggests: "
#> [32] " covr,"
#> [33] " knitr,"
#> [34] " rmarkdown,"
#> [35] " testthat"
#> [36] "VignetteBuilder: "
#> [37] " knitr"
#> [38] "RdMacros: "
#> [39] " details"
#> [40] "Encoding: UTF-8"
#> [41] "LazyData: true"
#> [42] "Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)"
#> [43] "RoxygenNote: 7.2.1"The main job of the R6 object is to convert all the options into a uri that is sent to the carbon url page, where it is processed.
x$uri()
#> [1] "https://carbon.now.sh/?bg=rgba(171%2C175%2C195%2C0.7)&t=panda-syntax&wt=none&l=r&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=11px&ph=14px&ln=false&fm=Fira%20Code&fs=14px&lh=133%25&si=false&es=1x&wm=false&ts=false&code=Package%253A%2520carbonate%250ATitle%253A%2520Interact%2520with%2520%27carbon.js%27%250AVersion%253A%25200.2.0%250AAuthors%2540R%253A%2520%250A%2520%2520%2520%2520person(given%2520%253D%2520%2522Jonathan%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520family%2520%253D%2520%2522Sidi%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520role%2520%253D%2520c(%2522aut%2522%252C%2520%2522cre%2522)%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520email%2520%253D%2520%2522yonicd%2540gmail.com%2522%252C%250A%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520%2520comment%2520%253D%2520c(ORCID%2520%253D%2520%25220000-0002-4222-1819%2522))%250ADescription%253A%2520Create%2520beautiful%2520images%2520of%2520source%2520code%2520using%250A%2520%2520%2520%2520%27carbon.js%27%253Chttps%253A%252F%252Fcarbon.now.sh%252Fabout%253E.%250ALicense%253A%2520MIT%2520%252B%2520file%2520LICENSE%250AURL%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%250ABugReports%253A%2520https%253A%252F%252Fgithub.com%252Fyonicd%252Fcarbonate%252Fissues%250ADepends%253A%2520%250A%2520%2520%2520%2520R%2520(%253E%253D%25203.2.0)%250AImports%253A%2520%250A%2520%2520%2520%2520clipr%252C%250A%2520%2520%2520%2520details%252C%250A%2520%2520%2520%2520httpuv%252C%250A%2520%2520%2520%2520httr%252C%250A%2520%2520%2520%2520magick%252C%250A%2520%2520%2520%2520R6%252C%250A%2520%2520%2520%2520reprex%252C%250A%2520%2520%2520%2520RSelenium%252C%250A%2520%2520%2520%2520rtweet%252C%250A%2520%2520%2520%2520utils%252C%250A%2520%2520%2520%2520wdman%252C%250A%2520%2520%2520%2520jsonlite%252C%250A%2520%2520%2520%2520yaml%250ASuggests%253A%2520%250A%2520%2520%2520%2520covr%252C%250A%2520%2520%2520%2520knitr%252C%250A%2520%2520%2520%2520rmarkdown%252C%250A%2520%2520%2520%2520testthat%250AVignetteBuilder%253A%2520%250A%2520%2520%2520%2520knitr%250ARdMacros%253A%2520%250A%2520%2520%2520%2520details%250AEncoding%253A%2520UTF-8%250ALazyData%253A%2520true%250ARoxygen%253A%2520list(markdown%2520%253D%2520TRUE%252Cold_usage%2520%253D%2520TRUE%252Cr6%2520%253D%2520FALSE)%250ARoxygenNote%253A%25207.2.1"Click the link to see the URI works.
Manipulate carbon object
Aesthetics of the carbon object that can be manipulated
| Carbon Variable | Carbonate Variable | Description | Default |
|---|---|---|---|
| l | language | language | r |
| bg | palette | layout pallete (vector with c(r,g,b,a) | c(r=171,g=184,b=195,a=1) |
| t | template | layout template (listed in get_templates()) | ‘seti’ |
| wc | add_window_control | add/remove window controls (circles on top left corner) | TRUE |
| wt | window_control_theme | change window control themes (listed in get_windows_control_themes()) | ‘none’ |
| ds | add_drop_shadow | add/remove dropshadow | TRUE |
| dsyoff | drop_shadow_offset_y | shadow vertical offset (px) | 20 |
| dsblur | drop_shadow_blur_radius | shadow blur radius (px) | 68 |
| wa | auto_adjust_width | auto-audjust output width | TRUE |
| pv | padding_vertical | vertical padding (px) | 48 |
| ph | padding_horizontal | horizontal padding (px) | 32 |
| ln | add_line_number | add/remove line numbers | FALSE |
| fm | font_family | layout font family (listed in get_font_families()) | ‘Hack’ |
| fs | font_size | font size (px) | 14 |
| lh | line_height_percent | relative space between lines (percent) | 133 |
| si | square_image | output image is square | FALSE |
| es | relative_export_size | image size in export relative to what is in the preview (1,2 or 4) | 1 |
| wm | add_watermark | add official carbon.js watermark | FALSE |
x$get_templates()
#> [1] "3024-night" "a11y-dark" "blackboard"
#> [4] "base16-dark" "base16-light" "cobalt"
#> [7] "dracula" "duotone-dark" "hopscotch"
#> [10] "lucario" "material" "monokai"
#> [13] "night-owl" "nord" "oceanic-next"
#> [16] "one-light" "one-dark" "panda-syntax"
#> [19] "paraiso-dark" "seti" "shades-of-purple"
#> [22] "solarized dark" "solarized light" "synthwave-84"
#> [25] "twilight" "verminal" "vscode"
#> [28] "yeti" "zenburn"
x$get_font_families()
#> [1] "Anonymous Pro" "Cascadia Code" "Droid Sans Mono"
#> [4] "Fantasque Sans Mono" "Fira Code" "Hack"
#> [7] "IBM Plex Mono" "Inconsolata" "JetBrains Mono"
#> [10] "Monoid" "Source Code Pro" "Space Mono"
#> [13] "Ubuntu Mono"
x$get_windows_control_themes()
#> [1] "none" "sharp" "bw"Personal Configuration
Users can use a file called carbon.yml and place it in their home directory (~) to override the packages defaults in order to create a session peristent carbon template they like. The config file controls all the public carbon object fields. The following is an example of such a configuration file.
These fields will set
- The palette (rgba)
gandafields to 175 and 0.7 respectively - The template will be set to
panda-syntax - The font to
Fira Code - The padding around the output will be made tighter than the system defaults 11px and 14px.
palette:
- g: 175.0
- a: 0.7
template: panda-syntax
font_family: Fira Code
padding_vertical: 11
padding_horizontal: 14Set the download directory
x$download_path <- file.path('README_files/download')Carbonate code directly to file
This function depends on RSelenium
x$carbonate(file = 'myfile.png')
x$template <-'cobalt'
x$carbonate(file = 'new_template.png')
x$font_family <-'IBM Plex Mono'
x$carbonate(file = 'new_font.png')
Sharing
Tinyurl
You can also put a tinyurl link as a watermark on the image produced that will open to the carbon.now.sh page that has the code in the image.
x$add_tinyurl <- TRUE
x$carbonate(file = 'tiny_url.png')
If you just want the tinyurl link without the image to use in a tweet you can create it using
x$tiny()
#> [1] "https://tinyurl.com/2kvjyzlx"Or you can put the link directly on your clipboard
x$tiny(clip = TRUE)
#> [1] "https://tinyurl.com/2kvjyzlx"
clipr::read_clip()
#> [1] "https://tinyurl.com/2kvjyzlx"Direct
You can also directly tweet the image. An automatic status is created with two options
- Default
- Created in R using the Carbonate 📦
- When
add_tinyurl <- TRUE- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx
- Manual
- Using
tweet_statusyou can write your own status.
- Using
x <- carbonate::carbon$new()
x$tweet <- TRUE
x$carbonate()Post process (Batch)
If you have images stored in x$carbons you can post them also in a tweet using.
# for multiple png attachments
x$rtweet(x$carbons,media_type = 'png') #using default status
# subsets of images
x$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')
# for gifs
x$rtweet(status='This is a gif', x$carbons,media_type = 'gif')Post image processing
All carbon outputs are collected and saved in the list x$carbons
Combining
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append()
x$carbons%>%
magick::image_scale('300')%>%
magick::image_append(stack = TRUE)
opens the uri address in $uri in the browser window.
.browse(self, private)Arguments
- self
carbon self object
- private
carbon private object
See also
Examples
x <- carbon$new('x <- 1')
#> Set via '~/carbon.yml'
#> palette:
#> - 171.0
#> - 175.0
#> - 195.0
#> - 0.7
#> template: panda-syntax
#> font_family: Fira Code
#> padding_vertical: 11
#> padding_horizontal: 14
#> language: r
if(interactive())
x$browse()
The Carbon generator creates a new Carbon-object, which is the class containing
all the app logic. The class is based on the R6 OO-system and
is thus reference-based with methods and data attached to each object, in
contrast to the more well known S3 and S4 systems.
Initialization
A new 'Carbon'-object is initialized using the new() method on the generator:
x <- carbon$new(code = clipr::read_clip()) |
Fields
Public Fields
Description of fields of the R6 object that can be set by the user can be found in the following page.
Methods
Interacting with Browser
| $carbonate | Using RSelenium fetch the carbon image output |
| $browse | open $uri in the browser |
Aesthetics
| $set_template | set $template |
| $get_templates | get a list of possible templates |
| $set_window_control_theme | set $windows_control_theme |
| $get_windows_control_themes | get a list of possible window control themes |
| $set_font_family | set $font_family |
| $get_font_families | get a list of possible fonts |
URI Building
| $uri | construct valid carbon.js uri |
| $options | return all current carbon options |
| $encode | URL encode a string for the $uri |
| $tiny | Create tinyurl from $uri |
| $rtweet | Send tweets containing media generated from carbon |
Webdriver Settings
| $chromeOptions | construct a chromeOptions object |
| $chrome_start | start a chrome session |
| $chrome_stop | stop a chrome session |
| $start | start a RSelenium session |
| $stop | stop a RSelenium session |
| $stop_all | stop all active RSelenium sessions |
| $get_port | Get active port |
| $set_port | Set new port |
Functions to open,close,set chrome webdriver
.chromeOptions(self, private)Arguments
- self
carbon self object
- private
carbon private object
Fields that can be changed in the Carbon object
Arguments
- code
character, script to embbed, Default: NULL
- palette
numeric, layout pallete, Default: c(r=171,g=184,b=195,a=1)
- template
character, layout template, Default: 'seti'
- add_window_control
boolean, add/remove window controls (circles on top left corner), Default: TRUE
- window_control_theme
character, change window control themes, Default: 'none'
- language
character, language, Default: 'r'
- add_drop_shadow
boolean, add/remove dropshadow, Default: TRUE
- drop_shadow_offset_y
numeric, shadow vertical offset (px), Default: 20
- drop_shadow_blur_radius
numeric, shadow blur radius (px), Default: 68
- auto_adjust_width
boolean, auto-audjust output width, Default: TRUE
- padding_vertical
numeric, vertical padding (px), Default: 48
- padding_horizontal
numeric, horizontal padding (px), Default: 32
- add_line_number
boolean, add/remove line numbers, Default: FALSE
- font_family
character, layout font family, Default: 'Hack'
- font_size
numeric, font size (px), Default: 14
- line_height_percent
numeric, relative space between lines (percent), Default: 133
- square_image
boolean, output image is square, Default: FALSE
- relative_export_size
numeric, image size in export relative to what is in the preview (1,2 or 4), Default: 1
- add_watermark
boolean, add official carbon.js watermark, Default: FALSE
- add_tinyurl
boolean, add tinyurl link to image directing to the carbon page that created the image, Default: FALSE
- tinyurl_location
character, string with gravity value to place the annotate tinyurl address on image, Default: 'southeast'
- tweet
boolean, tweet out the image using post_tweet
- tweet_status
character, status to add to the tweet. If add_tinyurl is TRUE then a link to the url will be appended to the status automatically, Default: 'Created in R using the Carbonate (Package Icon)'
- add_timestamp
boolean, add timestamp to output filename, Default: FALSE
- carbons
list, storage of rendered carbon images, Default: NULL
- download_path
character, path to download the images, Default: tempdir()
- chrome_args
character, arguments passed to chrome browser, Default: c('--disable-gpu', '--window-size=1280,800')
- chrome_pref
list, preferences passed to chrome browser, Default: list("profile.default_content_settings.popups" = 0L,"download.prompt_for_download" = FALSE,"download.default_directory" = tempdir())
- rD
RSelenium Driver object
- cDrv
Chrome Driver object from wdman
See also
Functions to open,close,set gecko webdriver
.firefoxOptions(self, private)Arguments
- self
carbon self object
- private
carbon private object
Functions to open,stop, stop_all RSelenium sessions
Arguments
See also
Main function of the package that invokes RSelenium to open a browser to the carbon.js uri, create an image and download the file.
.carbonate(self, private, file, path, code, rD, driver)Arguments
- self
carbon self object
- private
carbon private object
- file
character, name of file to save image as
- path
character, path to save the image
- code
character, lines of script to make carbon image from
- rD
RSelenium driver
- driver
character, select either 'firefox' or 'chrome' driver
Value
image object
Details
Script is passed to https://carbon.now.sh/ is downloaded to the tempdir() and appended to the list $carbons using RSelenium and Chrome.
Examples
if(interactive()){
x <- carbon$new('x <- 1')
x$carbonate()
}
encode uri string for carbon.js. Augmented version of than URLencode
.encode(self, private, URL, reserved, repeated)Arguments
- self
carbon self object
- private
carbon private object
- URL
character, uri string to url encode
- reserved
boolean, should ‘reserved’ characters be encoded?
- repeated
boolean, should apparently already-encoded URLs be encoded again?
Value
character
function that gets the available list of aesthetic values of fields
.get_windows_control_themes(self, private)
.get_font_families(self, private)
.get_templates(self, private)Arguments
- self
carbon self object
- private
carbon private object
See also
Reference
All functions |
|
|---|---|
open $uri to in browser window |
|
Carbon R6 class |
|
chrome webdriver functions |
|
Carbon object fields |
|
gecko webdriver functions |
|
|
|
RSelenium webdriver functions |
Carbonate script lines to a carbon image |
|
encode uri for carbon.js |
|
|
|
carbon get functions |
concatenate the carbon options to a string |
|
Creates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon |
|
send tweets using carbonate outputs |
|
|
|
carbon set functions |
convert carbon uri to tinyurl |
|
convert uri to tinyurl |
|
URI constructor |
|
combine all the carbon options into a carbon.js valid string
.options(self, private, code)Arguments
- self
carbon self object
- private
carbon private object
- code
character, script to embbed into the uri
Value
OUTPUT_DESCRIPTION
See also
Creates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon
Source:R/addins.R
reprex_to_carbon_browser.RdCreates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon
reprex_to_carbon_browser(..., html_preview = FALSE, style = TRUE,
url_only = FALSE)
reprex_to_carbon_download(..., file = "carbon_reprex.png",
html_preview = FALSE, style = TRUE, url_only = FALSE)Arguments
- ...
arguments passed to reprex::reprex
- html_preview
show also reprex html result? Default is false
- style
should the code be styled? Default is True
- url_only
if only the URL should be returned without opening the browser
Value
the URL to the Carbon (invisible) or the filename (invisible)
Functions
reprex_to_carbon_download(): downloads the picture
wrapper for post_tweet to send tweets with media created using carbonate.
.rtweet(self, private, media, status = self$tweet_status,
media_format = c("png", "gif"), ...)Arguments
- self
carbon self object
- private
carbon private object
- media
magick-image object or path to image
- status
character, status to attach to post, Default: self$tweet_status
- media_format
character, type of media to tweet, Default: c('png','gif')
- ...
arguments to pass to post_tweet
Value
outcome from rtweet
Details
If multiple images are passed they can be either converted to a gif by setting media_format to 'gif' or attached each one to the post.
See also
Examples
if (FALSE) {
x <- carbonate::carbon$new()
x$carbonate(code = readLines(system.file('DESCRIPTION',package='carbonate')))
x$carbonate(code = 'x+2')
# using default status value (x$tweet_status)
x$rtweet(system.file('figures/hex_black_small.png',package='carbonate'))
x$rtweet(status = 'these are two pngs',media = x$carbons,media_format='png')
x$rtweet(status = 'this is a gif', media = x$carbons,media_format='gif')
}
function that set the aesthetics of the carbon image output
.set_template(self, private, template)
.set_window_control_theme(self, private, theme)
.set_font_family(self, private, family)Arguments
- self
carbon self object
- private
carbon private object
- template
character, name of template to set $template to
- theme
character, theme to set $theme to
- family
character, font family to set $font_family to
See also
convert carbon uri to tinyurl with option to attach to clipboard.
.tiny(self, private, clip = FALSE)Arguments
- self
carbon self object
- private
carbon private object
- clip
boolean, write tinyurl to clipboard, Default: FALSE
Value
character
Details
If clip is set to TRUE write_clip will put the tinyurl on the clipboard.
convert uri to tinyurl.
tinyurl(uri)Arguments
- uri
character, the uri to convert
Value
character
Function that is called in a carbon object to construct valid uri to send to browser
.uri(self, private, code)Arguments
- self
carbon self object
- private
carbon private object
- code
character, script to embbed into the uri
See also
Examples
if(interactive()){
x <- carbon$new('x <- 1')
# populate from self$code
x$uri()
# enter manually
x$uri(code = 'x <- y + 3')
}
## Unit Tests Unit Test summary is created using the [testthat](https://github.com/r-lib/testthat) package. | file | n | time | error | failed | skipped | warning | icon | |:------------------------------------|----:|------:|------:|-------:|--------:|--------:|:-----| | [test-port.R](testthat/test-port.R) | 3 | 0.024 | 0 | 0 | 0 | 0 | | | [test-set.R](testthat/test-set.R) | 3 | 0.893 | 0 | 0 | 0 | 0 | | | [test-uri.R](testthat/test-uri.R) | 8 | 1.342 | 0 | 0 | 2 | 0 | 🔶 | | [test-yml.R](testthat/test-yml.R) | 6 | 2.351 | 0 | 0 | 0 | 0 | |
Show Detailed Test Results
| file | context | test | status | n | time | icon | |:----------------------------------------|:--------|:-----------------------------------------|:--------|----:|------:|:-----| | [test-port.R](testthat/test-port.R#L9) | port | port: init | PASS | 1 | 0.011 | | | [test-port.R](testthat/test-port.R#L14) | port | port: reset | PASS | 1 | 0.011 | | | [test-port.R](testthat/test-port.R#L19) | port | port: manual | PASS | 1 | 0.002 | | | [test-set.R](testthat/test-set.R#L8) | set\_ | set functions: set_template | PASS | 1 | 0.529 | | | [test-set.R](testthat/test-set.R#L13) | set\_ | set functions: set_font_family | PASS | 1 | 0.363 | | | [test-set.R](testthat/test-set.R#L18) | set\_ | set functions: set_windows_control_theme | PASS | 1 | 0.001 | | | [test-uri.R](testthat/test-uri.R#L9) | uri | options: benchmark | PASS | 1 | 0.325 | | | [test-uri.R](testthat/test-uri.R#L17) | uri | uri: benchmark | PASS | 1 | 0.235 | | | [test-uri.R](testthat/test-uri.R#L21) | uri | uri: 200 | PASS | 1 | 0.528 | | | [test-uri.R](testthat/test-uri.R#L27) | uri | encode: encode character | PASS | 1 | 0.002 | | | [test-uri.R](testthat/test-uri.R#L31) | uri | encode: no encode character | PASS | 1 | 0.001 | | | [test-uri.R](testthat/test-uri.R#L37) | uri | tiny: valid tiny | SKIPPED | 1 | 0.001 | 🔶 | | [test-uri.R](testthat/test-uri.R#L43) | uri | tiny: clipboard | SKIPPED | 1 | 0.002 | 🔶 | | [test-uri.R](testthat/test-uri.R#) | uri | bad template: error uri | PASS | 1 | 0.248 | | | [test-yml.R](testthat/test-yml.R#L24) | yml | yaml fields: rgba | PASS | 1 | 0.525 | | | [test-yml.R](testthat/test-yml.R#L29) | yml | yaml fields: template | PASS | 1 | 0.432 | | | [test-yml.R](testthat/test-yml.R#L34) | yml | yaml fields: bad font family | PASS | 1 | 0.439 | | | [test-yml.R](testthat/test-yml.R#L39) | yml | yaml fields: pv | PASS | 1 | 0.522 | | | [test-yml.R](testthat/test-yml.R#L44) | yml | yaml fields: ph | PASS | 1 | 0.431 | | | [test-yml.R](testthat/test-yml.R#L59) | yml | namesless palette: fill in palette | PASS | 1 | 0.002 | | | Failed | Warning | Skipped | |:-------|:--------|:--------| | 🛑 | ⚠️ | 🔶 |Session Info
| Field | Value | |:---------|:---------------------------------| | Version | R version 4.2.1 (2022-06-23) | | Platform | x86_64-apple-darwin17.0 (64-bit) | | Running | macOS Big Sur 11.6 | | Language | en_US | | Timezone | America/New_York | | Package | Version | |:---------|:--------| | testthat | 3.1.4 | | covr | 3.5.1 | | covrpage | 0.1 |## Unit Tests Unit Test summary is created using the [testthat](https://github.com/r-lib/testthat) package. | file | n | time | error | failed | skipped | warning | icon | |:------------------------------------|----:|------:|------:|-------:|--------:|--------:|:-----| | [test-port.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-port.R) | 3 | 0.116 | 0 | 0 | 0 | 0 | | | [test-set.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-set.R) | 3 | 0.812 | 0 | 0 | 0 | 0 | | | [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R) | 8 | 1.257 | 0 | 0 | 2 | 0 | 🔶 | | [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R) | 6 | 2.591 | 0 | 0 | 0 | 0 | |