Tinyurl
\n\nYou 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.\n\n```{r,echo=FALSE}\nSys.sleep(2)\n```\n\n```{r}\nx$add_tinyurl <- TRUE\nx$carbonate(file = 'tiny_url.png')\n```\n\nIf you just want the tinyurl link without the image to use in a tweet you can create it using\n\n```{r}\nx$tiny()\n```\n\nOr you can put the link directly on your clipboard\n\n```{r, eval = interactive()}\nx$tiny(clip = TRUE)\nclipr::read_clip()\n```\n\nCombining
\n\n```{r}\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append()\n\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append(stack = TRUE)\n```\n\nGIFs
\n\n```{r}\nx$carbons%>%\n magick::image_animate(fps = 1)\n```\n\n\n
\n\nTinyurl\n
\n\nYou can also put a tinyurl link as a watermark on the image produced\nthat will open to the carbon.now.sh page that has the code in the image.\n\n``` r\nx$add_tinyurl <- TRUE\nx$carbonate(file = 'tiny_url.png')\n```\n\n\n\nIf you just want the tinyurl link without the image to use in a tweet\nyou can create it using\n\n``` r\nx$tiny()\n#> [1] \"https://tinyurl.com/2n72r6pk\"\n```\n\nOr you can put the link directly on your clipboard\n\n``` r\nx$tiny(clip = TRUE)\nclipr::read_clip()\n```\n\n\n\n- Manual\n - Using `tweet_status` you can write your own status.\n\n``` r\nx <- carbonate::carbon$new()\nx$tweet <- TRUE\nx$carbonate()\n```\n\n##### Post process (Batch)\n\nIf you have images stored in `x$carbons` you can post them also in a\ntweet using.\n\n``` r\n# for multiple png attachments\nx$rtweet(x$carbons,media_type = 'png') #using default status\n\n# subsets of images\nx$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')\n\n# for gifs\nx$rtweet(status='This is a gif', x$carbons,media_type = 'gif')\n```\n\n
\n\n### Post image processing\n\nAll carbon outputs are collected and saved in the list `x$carbons`\n\n\nTwitter\n
\n\n##### Direct\n\nYou can also directly tweet the image. An automatic status is created\nwith two options\n\n- Default\n - Created in R using the Carbonate 📦\n- When `add_tinyurl <- TRUE`\n - Created in R using the Carbonate 📦 Check out this script at 🔗\n\n
\n\nCombining\n
\n\n``` r\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append()\n```\n\n\n\n``` r\n\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append(stack = TRUE)\n```\n\n\n\n\n
\n"
},
{
"path": "_pkgdown.yml",
"content": "hexURL:\n https://github.com/yonicd/carbonate/blob/master/hextools/hex.gif?raw=true\n"
},
{
"path": "carbonate.Rproj",
"content": "Version: 1.0\n\nRestoreWorkspace: No\nSaveWorkspace: No\nAlwaysSaveHistory: Default\n\nEnableCodeIndexing: Yes\nUseSpacesForTab: Yes\nNumSpacesForTab: 2\nEncoding: UTF-8\n\nRnwWeave: Sweave\nLaTeX: pdfLaTeX\n\nBuildType: Package\nPackageUseDevtools: Yes\nPackageInstallArgs: --no-multiarch --with-keep.source\nPackageRoxygenize: rd,collate,namespace,vignette\n\nQuitChildProcessesOnExit: Yes\n"
},
{
"path": "codecov.yml",
"content": "comment: false\n"
},
{
"path": "cran-comments.md",
"content": "## Test environments\n* local OS X install, R 3.5.1\n* ubuntu 12.04 (on travis-ci), R 3.5.1\n* win-builder (devel and release)\n\n## R CMD check results\n\n0 errors | 0 warnings | 1 note\n\n* This is a new release.\n\n## Reverse dependencies\n\nThis is a new release, so there are no reverse dependencies.\n\n---\n\n* I have run R CMD check on the NUMBER downstream dependencies.\n (Summary at ...). \n \n* FAILURE SUMMARY\n\n* All revdep maintainers were notified of the release on RELEASE DATE.\n"
},
{
"path": "docs/404.html",
"content": "\n\n\n\n\n\n\n\nGIFs\n
\n\n``` r\nx$carbons%>%\n magick::image_animate(fps = 1)\n```\n\n\n\n\n \n\n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/LICENSE-text.html",
"content": "\n\n
\n\n\n\n \n\n
\n\n \n
\n\nContent not found. Please use links in the navbar.\n\n Page not found (404)
\n\n \n
\n\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/PULL_REQUEST_TEMPLATE.html",
"content": "\n\n
\n\n\n\n \n
\n\n \n
\n\nLicense
\nYEAR: 2018\nCOPYRIGHT HOLDER: Jonathan Sidi\n\n\n
\n
\n\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/articles/index.html",
"content": "\n\n
\n\n\n\n \n
\n\n \n
\n\n\nNA
\nHi, thanks for contributing!
\nPlease make sure you read our CONTRIBUTING guide.
\nPlease fill the fields above:
\n\n\n\n\n\n\n
\n\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/articles/tests_and_coverage.html",
"content": "\n\n\n\n\n\n\n\n
\n\n\n \n
\n\n
\n\n Articles
\n\n
\n All vignettes
\n \n\n- Tests and Coverage \n
- \n
\n \n\n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/authors.html",
"content": "\n\n
\n\n\n\n \n\n
\n\n \n \n\n
\n\n \n \n\nTests and Coverage
\n \n21 August, 2022 21:06:53
\n \n Source:vignettes/tests_and_coverage.Rmd\n tests_and_coverage.RmdThis output is created by covrpage.
\n\n\n
\n
\nCoverage\n
\nCoverage summary is created using the covr package.
\n| Object | \nCoverage (%) | \n
|---|---|
| carbonate | \n48.58 | \n
| R/carbonate.R | \n0.00 | \n
| R/selenium_functions.R | \n0.00 | \n
| R/uri_functions.R | \n52.63 | \n
| R/carbon.R | \n64.29 | \n
| R/helpers.R | \n70.09 | \n
| R/set_get_functions.R | \n100.00 | \n
\n\n
\n\n
\n\n
\n
\n\n
\n
\n Unit Tests\n
\nUnit Test summary is created using the testthat package.
\n| file | \nn | \ntime | \nerror | \nfailed | \nskipped | \nwarning | \nicon | \n
|---|---|---|---|---|---|---|---|
| test-set.R | \n3 | \n0.013 | \n0 | \n0 | \n0 | \n0 | \n\n |
| test-uri.R | \n8 | \n1.352 | \n0 | \n0 | \n1 | \n0 | \n🔶 | \n
| test-yml.R | \n6 | \n0.017 | \n0 | \n0 | \n0 | \n0 | \n\n |
\nShow Detailed Test Results\n
| file | \ncontext | \ntest | \nstatus | \nn | \ntime | \nicon | \n
|---|---|---|---|---|---|---|
| test-set.R | \nset_ | \nset functions: set_template | \nPASS | \n1 | \n0.011 | \n\n |
| test-set.R | \nset_ | \nset functions: set_font_family | \nPASS | \n1 | \n0.001 | \n\n |
| test-set.R | \nset_ | \nset functions: set_windows_control_theme | \nPASS | \n1 | \n0.001 | \n\n |
| test-uri.R | \nuri | \noptions: benchmark | \nPASS | \n1 | \n0.002 | \n\n |
| test-uri.R | \nuri | \nuri: benchmark | \nPASS | \n1 | \n0.002 | \n\n |
| test-uri.R | \nuri | \nuri: 200 | \nPASS | \n1 | \n0.721 | \n\n |
| test-uri.R | \nuri | \nencode: encode character | \nPASS | \n1 | \n0.002 | \n\n |
| test-uri.R | \nuri | \nencode: no encode character | \nPASS | \n1 | \n0.001 | \n\n |
| test-uri.R | \nuri | \ntiny: valid tiny | \nPASS | \n1 | \n0.620 | \n\n |
| test-uri.R | \nuri | \ntiny: clipboard | \nSKIPPED | \n1 | \n0.001 | \n🔶 | \n
| test-uri.R | \nuri | \nbad template: error uri | \nPASS | \n1 | \n0.003 | \n\n |
| test-yml.R | \nyml | \nyaml fields: rgba | \nPASS | \n1 | \n0.006 | \n\n |
| test-yml.R | \nyml | \nyaml fields: template | \nPASS | \n1 | \n0.003 | \n\n |
| test-yml.R | \nyml | \nyaml fields: bad font family | \nPASS | \n1 | \n0.002 | \n\n |
| test-yml.R | \nyml | \nyaml fields: pv | \nPASS | \n1 | \n0.002 | \n\n |
| test-yml.R | \nyml | \nyaml fields: ph | \nPASS | \n1 | \n0.002 | \n\n |
| test-yml.R | \nyml | \nnamesless palette: fill in palette | \nPASS | \n1 | \n0.002 | \n\n |
| Failed | \nWarning | \nSkipped | \n
|---|---|---|
| 🛑 | \n⚠️ | \n🔶 | \n
\nSession Info\n
| Field | \nValue | \n
|---|---|
| Version | \nR version 3.5.1 (2018-07-02) | \n
| Platform | \nx86_64-apple-darwin15.6.0 (64-bit) | \n
| Running | \nmacOS 10.14.2 | \n
| Language | \nen_US | \n
| Timezone | \nAmerica/Chicago | \n
| Package | \nVersion | \n
|---|---|
| testthat | \n2.0.0.9000 | \n
| covr | \n3.2.0 | \n
| covrpage | \n0.0.69 | \n
\n\n \n
\n\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/bootstrap-toc.css",
"content": "/*!\n * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)\n * Copyright 2015 Aidan Feldman\n * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */\n\n/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */\n\n/* All levels of nav */\nnav[data-toggle='toc'] .nav > li > a {\n display: block;\n padding: 4px 20px;\n font-size: 13px;\n font-weight: 500;\n color: #767676;\n}\nnav[data-toggle='toc'] .nav > li > a:hover,\nnav[data-toggle='toc'] .nav > li > a:focus {\n padding-left: 19px;\n color: #563d7c;\n text-decoration: none;\n background-color: transparent;\n border-left: 1px solid #563d7c;\n}\nnav[data-toggle='toc'] .nav > .active > a,\nnav[data-toggle='toc'] .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav > .active:focus > a {\n padding-left: 18px;\n font-weight: bold;\n color: #563d7c;\n background-color: transparent;\n border-left: 2px solid #563d7c;\n}\n\n/* Nav: second level (shown on .active) */\nnav[data-toggle='toc'] .nav .nav {\n display: none; /* Hide by default, but at >768px, show it */\n padding-bottom: 10px;\n}\nnav[data-toggle='toc'] .nav .nav > li > a {\n padding-top: 1px;\n padding-bottom: 1px;\n padding-left: 30px;\n font-size: 12px;\n font-weight: normal;\n}\nnav[data-toggle='toc'] .nav .nav > li > a:hover,\nnav[data-toggle='toc'] .nav .nav > li > a:focus {\n padding-left: 29px;\n}\nnav[data-toggle='toc'] .nav .nav > .active > a,\nnav[data-toggle='toc'] .nav .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav .nav > .active:focus > a {\n padding-left: 28px;\n font-weight: 500;\n}\n\n/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */\nnav[data-toggle='toc'] .nav > .active > ul {\n display: block;\n}\n"
},
{
"path": "docs/bootstrap-toc.js",
"content": "/*!\n * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/)\n * Copyright 2015 Aidan Feldman\n * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */\n(function() {\n 'use strict';\n\n window.Toc = {\n helpers: {\n // return all matching elements in the set, or their descendants\n findOrFilter: function($el, selector) {\n // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/\n // http://stackoverflow.com/a/12731439/358804\n var $descendants = $el.find(selector);\n return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])');\n },\n\n generateUniqueIdBase: function(el) {\n var text = $(el).text();\n var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-');\n return anchor || el.tagName.toLowerCase();\n },\n\n generateUniqueId: function(el) {\n var anchorBase = this.generateUniqueIdBase(el);\n for (var i = 0; ; i++) {\n var anchor = anchorBase;\n if (i > 0) {\n // add suffix\n anchor += '-' + i;\n }\n // check if ID already exists\n if (!document.getElementById(anchor)) {\n return anchor;\n }\n }\n },\n\n generateAnchor: function(el) {\n if (el.id) {\n return el.id;\n } else {\n var anchor = this.generateUniqueId(el);\n el.id = anchor;\n return anchor;\n }\n },\n\n createNavList: function() {\n return $('\n
\n\n\n\n \n \n
\n\n\n
\n\n\n \n
\n Citation
\n Source:DESCRIPTION\n Sidi J (2022).\ncarbonate: Interact with 'carbon.js'.\nR package version 0.2.0, https://github.com/yonicd/carbonate. \n
\n@Manual{,\n title = {carbonate: Interact with 'carbon.js'},\n author = {Jonathan Sidi},\n year = {2022},\n note = {R package version 0.2.0},\n url = {https://github.com/yonicd/carbonate},\n}\n\n `, then ``, etc.) that has more than one element. Defaults to 1 (for ``).\n getTopLevel: function($scope) {\n for (var i = 1; i <= 6; i++) {\n var $headings = this.findOrFilter($scope, 'h' + i);\n if ($headings.length > 1) {\n return i;\n }\n }\n\n return 1;\n },\n\n // returns the elements for the top level, and the next below it\n getHeadings: function($scope, topLevel) {\n var topSelector = 'h' + topLevel;\n\n var secondaryLevel = topLevel + 1;\n var secondarySelector = 'h' + secondaryLevel;\n\n return this.findOrFilter($scope, topSelector + ',' + secondarySelector);\n },\n\n getNavLevel: function(el) {\n return parseInt(el.tagName.charAt(1), 10);\n },\n\n populateNav: function($topContext, topLevel, $headings) {\n var $context = $topContext;\n var $prevNav;\n\n var helpers = this;\n $headings.each(function(i, el) {\n var $newNav = helpers.generateNavItem(el);\n var navLevel = helpers.getNavLevel(el);\n\n // determine the proper $context\n if (navLevel === topLevel) {\n // use top level\n $context = $topContext;\n } else if ($prevNav && $context === $topContext) {\n // create a new level of the tree and switch to it\n $context = helpers.createChildNavList($prevNav);\n } // else use the current $context\n\n $context.append($newNav);\n\n $prevNav = $newNav;\n });\n },\n\n parseOps: function(arg) {\n var opts;\n if (arg.jquery) {\n opts = {\n $nav: arg\n };\n } else {\n opts = arg;\n }\n opts.$scope = opts.$scope || $(document.body);\n return opts;\n }\n },\n\n // accepts a jQuery object, or an options object\n init: function(opts) {\n opts = this.helpers.parseOps(opts);\n\n // ensure that the data attribute is in place for styling\n opts.$nav.attr('data-toggle', 'toc');\n\n var $topContext = this.helpers.createChildNavList(opts.$nav);\n var topLevel = this.helpers.getTopLevel(opts.$scope);\n var $headings = this.helpers.getHeadings(opts.$scope, topLevel);\n this.helpers.populateNav($topContext, topLevel, $headings);\n }\n };\n\n $(function() {\n $('nav[data-toggle=\"toc\"]').each(function(i, el) {\n var $nav = $(el);\n Toc.init($nav);\n });\n });\n})();\n"
},
{
"path": "docs/docsearch.css",
"content": "/* Docsearch -------------------------------------------------------------- */\n/*\n Source: https://github.com/algolia/docsearch/\n License: MIT\n*/\n\n.algolia-autocomplete {\n display: block;\n -webkit-box-flex: 1;\n -ms-flex: 1;\n flex: 1\n}\n\n.algolia-autocomplete .ds-dropdown-menu {\n width: 100%;\n min-width: none;\n max-width: none;\n padding: .75rem 0;\n background-color: #fff;\n background-clip: padding-box;\n border: 1px solid rgba(0, 0, 0, .1);\n box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);\n}\n\n@media (min-width:768px) {\n .algolia-autocomplete .ds-dropdown-menu {\n width: 175%\n }\n}\n\n.algolia-autocomplete .ds-dropdown-menu::before {\n display: none\n}\n\n.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {\n padding: 0;\n background-color: rgb(255,255,255);\n border: 0;\n max-height: 80vh;\n}\n\n.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {\n margin-top: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion {\n padding: 0;\n overflow: visible\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--category-header {\n padding: .125rem 1rem;\n margin-top: 0;\n font-size: 1.3em;\n font-weight: 500;\n color: #00008B;\n border-bottom: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {\n float: none;\n padding-top: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {\n float: none;\n width: auto;\n padding: 0;\n text-align: left\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--content {\n float: none;\n width: auto;\n padding: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--content::before {\n display: none\n}\n\n.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {\n padding-top: .75rem;\n margin-top: .75rem;\n border-top: 1px solid rgba(0, 0, 0, .1)\n}\n\n.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {\n display: block;\n padding: .1rem 1rem;\n margin-bottom: 0.1;\n font-size: 1.0em;\n font-weight: 400\n /* display: none */\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--title {\n display: block;\n padding: .25rem 1rem;\n margin-bottom: 0;\n font-size: 0.9em;\n font-weight: 400\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--text {\n padding: 0 1rem .5rem;\n margin-top: -.25rem;\n font-size: 0.8em;\n font-weight: 400;\n line-height: 1.25\n}\n\n.algolia-autocomplete .algolia-docsearch-footer {\n width: 110px;\n height: 20px;\n z-index: 3;\n margin-top: 10.66667px;\n float: right;\n font-size: 0;\n line-height: 0;\n}\n\n.algolia-autocomplete .algolia-docsearch-footer--logo {\n background-image: url(\"data:image/svg+xml;utf8,\");\n background-repeat: no-repeat;\n background-position: 50%;\n background-size: 100%;\n overflow: hidden;\n text-indent: -9000px;\n width: 100%;\n height: 100%;\n display: block;\n transform: translate(-8px);\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--highlight {\n color: #FF8C00;\n background: rgba(232, 189, 54, 0.1)\n}\n\n\n.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {\n box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)\n}\n\n.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {\n background-color: rgba(192, 192, 192, .15)\n}\n"
},
{
"path": "docs/docsearch.js",
"content": "$(function() {\n\n // register a handler to move the focus to the search bar\n // upon pressing shift + \"/\" (i.e. \"?\")\n $(document).on('keydown', function(e) {\n if (e.shiftKey && e.keyCode == 191) {\n e.preventDefault();\n $(\"#search-input\").focus();\n }\n });\n\n $(document).ready(function() {\n // do keyword highlighting\n /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */\n var mark = function() {\n\n var referrer = document.URL ;\n var paramKey = \"q\" ;\n\n if (referrer.indexOf(\"?\") !== -1) {\n var qs = referrer.substr(referrer.indexOf('?') + 1);\n var qs_noanchor = qs.split('#')[0];\n var qsa = qs_noanchor.split('&');\n var keyword = \"\";\n\n for (var i = 0; i < qsa.length; i++) {\n var currentParam = qsa[i].split('=');\n\n if (currentParam.length !== 2) {\n continue;\n }\n\n if (currentParam[0] == paramKey) {\n keyword = decodeURIComponent(currentParam[1].replace(/\\+/g, \"%20\"));\n }\n }\n\n if (keyword !== \"\") {\n $(\".contents\").unmark({\n done: function() {\n $(\".contents\").mark(keyword);\n }\n });\n }\n }\n };\n\n mark();\n });\n});\n\n/* Search term highlighting ------------------------------*/\n\nfunction matchedWords(hit) {\n var words = [];\n\n var hierarchy = hit._highlightResult.hierarchy;\n // loop to fetch from lvl0, lvl1, etc.\n for (var idx in hierarchy) {\n words = words.concat(hierarchy[idx].matchedWords);\n }\n\n var content = hit._highlightResult.content;\n if (content) {\n words = words.concat(content.matchedWords);\n }\n\n // return unique words\n var words_uniq = [...new Set(words)];\n return words_uniq;\n}\n\nfunction updateHitURL(hit) {\n\n var words = matchedWords(hit);\n var url = \"\";\n\n if (hit.anchor) {\n url = hit.url_without_anchor + '?q=' + escape(words.join(\" \")) + '#' + hit.anchor;\n } else {\n url = hit.url + '?q=' + escape(words.join(\" \"));\n }\n\n return url;\n}\n"
},
{
"path": "docs/index.html",
"content": "\n\n\n\n\n\n\nInteract with carbon.js • carbonate \n\n\n\n\n\n\n\n\n\n\n \n\n \n \n\n\n \n\n \n \n\n\n“carbon.js is the easiest way to create beautiful images of your source code.”
\nThis package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
\nLike the image below:
\n![](\"reference/figures/unnamed-chunk-3-1.png\")
\n\nInstallation\n
\n\n#remotes::install_github('yonicd/carbonate')\ninstall.packages('carbonate')
\n\n\nUsage\n
\n\nInitialize new carbon object\n
\n\nThe default code in the carbon object is taken from the clipboard.
\n\nx <- carbon$new()
\nBut can also be defined inline. Code can be a character object of any length.
\n\nThe code is kept in the object and can be changed at any time.
\n\nx$code\n#> [1] \"Package: carbonate\" \n#> [2] \"Title: Interact with 'carbon.js'\" \n#> [3] \"Version: 0.2.0\" \n#> [4] \"Authors@R: \" \n#> [5] \" person(given = \\\"Jonathan\\\",\" \n#> [6] \" family = \\\"Sidi\\\",\" \n#> [7] \" role = c(\\\"aut\\\", \\\"cre\\\"),\" \n#> [8] \" email = \\\"yonicd@gmail.com\\\",\" \n#> [9] \" comment = c(ORCID = \\\"0000-0002-4222-1819\\\"))\" \n#> [10] \"Description: Create beautiful images of source code using\" \n#> [11] \" 'carbon.js'<https://carbon.now.sh/about>.\" \n#> [12] \"License: MIT + file LICENSE\" \n#> [13] \"URL: https://github.com/yonicd/carbonate\" \n#> [14] \"BugReports: https://github.com/yonicd/carbonate/issues\" \n#> [15] \"Depends: \" \n#> [16] \" R (>= 3.2.0)\" \n#> [17] \"Imports: \" \n#> [18] \" clipr,\" \n#> [19] \" details,\" \n#> [20] \" httpuv,\" \n#> [21] \" httr,\" \n#> [22] \" magick,\" \n#> [23] \" R6,\" \n#> [24] \" reprex,\" \n#> [25] \" RSelenium,\" \n#> [26] \" rtweet,\" \n#> [27] \" utils,\" \n#> [28] \" wdman,\" \n#> [29] \" jsonlite,\" \n#> [30] \" yaml\" \n#> [31] \"Suggests: \" \n#> [32] \" covr,\" \n#> [33] \" knitr,\" \n#> [34] \" rmarkdown,\" \n#> [35] \" testthat\" \n#> [36] \"VignetteBuilder: \" \n#> [37] \" knitr\" \n#> [38] \"RdMacros: \" \n#> [39] \" details\" \n#> [40] \"Encoding: UTF-8\" \n#> [41] \"LazyData: true\" \n#> [42] \"Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)\"\n#> [43] \"RoxygenNote: 7.2.1\"
\nThe 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.
\n\nx$uri()\n#> [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\"
\nClick the link to see the URI works.
\n\n\nManipulate carbon object\n
\nAesthetics of the carbon object that can be manipulated
\n\n\n \n\nCarbon Variable \nCarbonate Variable \nDescription \nDefault \n \n\n\nl \nlanguage \nlanguage \nr \n \n\nbg \npalette \nlayout pallete (vector with c(r,g,b,a) \nc(r=171,g=184,b=195,a=1) \n \n\nt \ntemplate \nlayout template (listed in get_templates()) \n‘seti’ \n \n\nwc \nadd_window_control \nadd/remove window controls (circles on top left corner) \nTRUE \n \n\nwt \nwindow_control_theme \nchange window control themes (listed in get_windows_control_themes()) \n‘none’ \n \n\nds \nadd_drop_shadow \nadd/remove dropshadow \nTRUE \n \n\ndsyoff \ndrop_shadow_offset_y \nshadow vertical offset (px) \n20 \n \n\ndsblur \ndrop_shadow_blur_radius \nshadow blur radius (px) \n68 \n \n\nwa \nauto_adjust_width \nauto-audjust output width \nTRUE \n \n\npv \npadding_vertical \nvertical padding (px) \n48 \n \n\nph \npadding_horizontal \nhorizontal padding (px) \n32 \n \n\nln \nadd_line_number \nadd/remove line numbers \nFALSE \n \n\nfm \nfont_family \nlayout font family (listed in get_font_families()) \n‘Hack’ \n \n\nfs \nfont_size \nfont size (px) \n14 \n \n\nlh \nline_height_percent \nrelative space between lines (percent) \n133 \n \n\nsi \nsquare_image \noutput image is square \nFALSE \n \n\nes \nrelative_export_size \nimage size in export relative to what is in the preview (1,2 or 4) \n1 \n \n\nwm \nadd_watermark \nadd official carbon.js watermark \nFALSE \n \n\n
\n\nx$get_templates()\n#> [1] \"3024-night\" \"a11y-dark\" \"blackboard\" \n#> [4] \"base16-dark\" \"base16-light\" \"cobalt\" \n#> [7] \"dracula\" \"duotone-dark\" \"hopscotch\" \n#> [10] \"lucario\" \"material\" \"monokai\" \n#> [13] \"night-owl\" \"nord\" \"oceanic-next\" \n#> [16] \"one-light\" \"one-dark\" \"panda-syntax\" \n#> [19] \"paraiso-dark\" \"seti\" \"shades-of-purple\"\n#> [22] \"solarized dark\" \"solarized light\" \"synthwave-84\" \n#> [25] \"twilight\" \"verminal\" \"vscode\" \n#> [28] \"yeti\" \"zenburn\"
\n\nx$get_font_families()\n#> [1] \"Anonymous Pro\" \"Cascadia Code\" \"Droid Sans Mono\" \n#> [4] \"Fantasque Sans Mono\" \"Fira Code\" \"Hack\" \n#> [7] \"IBM Plex Mono\" \"Inconsolata\" \"JetBrains Mono\" \n#> [10] \"Monoid\" \"Source Code Pro\" \"Space Mono\" \n#> [13] \"Ubuntu Mono\"
\n\nx$get_windows_control_themes()\n#> [1] \"none\" \"sharp\" \"bw\"
\n\n\nPersonal Configuration\n
\nUsers 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.
\nThese fields will set
\n\n- The palette (rgba)
g and a fields to 175 and 0.7 respectively \n- The template will be set to
panda-syntax\n \n- The font to
Fira Code\n \n- The padding around the output will be made tighter than the system defaults 11px and 14px.
\n
\n\n\n\n\nSet the download directory\n
\n\nx$download_path <- file.path('README_files/download')
\n\n\nCarbonate code directly to file\n
\nThis function depends on RSelenium
\n\nx$carbonate(file = 'myfile.png')
\n![](\"reference/figures/unnamed-chunk-16-1.png\")
\n\nx$template <-'cobalt'\nx$carbonate(file = 'new_template.png')
\n![](\"reference/figures/unnamed-chunk-18-1.png\")
\n\nx$font_family <-'IBM Plex Mono'\nx$carbonate(file = 'new_font.png')
\n![](\"reference/figures/unnamed-chunk-20-1.png\")
\n\n\n\n\nSharing\n
\n\nTinyurl\n
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.
\n\nx$add_tinyurl <- TRUE\nx$carbonate(file = 'tiny_url.png')
\n![](\"reference/figures/unnamed-chunk-23-1.png\")
\nIf you just want the tinyurl link without the image to use in a tweet you can create it using
\n\nx$tiny()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"
\nOr you can put the link directly on your clipboard
\n\nx$tiny(clip = TRUE)\n#> [1] \"https://tinyurl.com/2kvjyzlx\"\nclipr::read_clip()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"
\n\nTwitter\n
\nDirect\n
\nYou can also directly tweet the image. An automatic status is created with two options
\n\n- Default\n
\n- Created in R using the Carbonate 📦
\n
\n \n- When
add_tinyurl <- TRUE\n\n- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx\n
\n
\n \n- Manual\n
\n- Using
tweet_status you can write your own status. \n
\n \n
\n\nx <- carbonate::carbon$new()\nx$tweet <- TRUE\nx$carbonate()
\n\n\nPost process (Batch)\n
\nIf you have images stored in x$carbons you can post them also in a tweet using.
\n\n# for multiple png attachments\nx$rtweet(x$carbons,media_type = 'png') #using default status\n\n# subsets of images\nx$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')\n\n# for gifs\nx$rtweet(status='This is a gif', x$carbons,media_type = 'gif')
\n\n\n\n\n\nPost image processing\n
\nAll carbon outputs are collected and saved in the list x$carbons
\n\nCombining\n
\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append()
\n![](\"reference/figures/unnamed-chunk-28-1.png\")
\n\n\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append(stack = TRUE)
\n![](\"reference/figures/unnamed-chunk-28-2.png\")
\n\n\n\n\n \n\n \n\n\n\n \n\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/pkgdown.css",
"content": "/* Sticky footer */\n\n/**\n * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/\n * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css\n *\n * .Site -> body > .container\n * .Site-content -> body > .container .row\n * .footer -> footer\n *\n * Key idea seems to be to ensure that .container and __all its parents__\n * have height set to 100%\n *\n */\n\nhtml, body {\n height: 100%;\n}\n\nbody {\n position: relative;\n}\n\nbody > .container {\n display: flex;\n height: 100%;\n flex-direction: column;\n}\n\nbody > .container .row {\n flex: 1 0 auto;\n}\n\nfooter {\n margin-top: 45px;\n padding: 35px 0 36px;\n border-top: 1px solid #e5e5e5;\n color: #666;\n display: flex;\n flex-shrink: 0;\n}\nfooter p {\n margin-bottom: 0;\n}\nfooter div {\n flex: 1;\n}\nfooter .pkgdown {\n text-align: right;\n}\nfooter p {\n margin-bottom: 0;\n}\n\nimg.icon {\n float: right;\n}\n\n/* Ensure in-page images don't run outside their container */\n.contents img {\n max-width: 100%;\n height: auto;\n}\n\n/* Fix bug in bootstrap (only seen in firefox) */\nsummary {\n display: list-item;\n}\n\n/* Typographic tweaking ---------------------------------*/\n\n.contents .page-header {\n margin-top: calc(-60px + 1em);\n}\n\ndd {\n margin-left: 3em;\n}\n\n/* Section anchors ---------------------------------*/\n\na.anchor {\n display: none;\n margin-left: 5px;\n width: 20px;\n height: 20px;\n\n background-image: url(./link.svg);\n background-repeat: no-repeat;\n background-size: 20px 20px;\n background-position: center center;\n}\n\nh1:hover .anchor,\nh2:hover .anchor,\nh3:hover .anchor,\nh4:hover .anchor,\nh5:hover .anchor,\nh6:hover .anchor {\n display: inline-block;\n}\n\n/* Fixes for fixed navbar --------------------------*/\n\n.contents h1, .contents h2, .contents h3, .contents h4 {\n padding-top: 60px;\n margin-top: -40px;\n}\n\n/* Navbar submenu --------------------------*/\n\n.dropdown-submenu {\n position: relative;\n}\n\n.dropdown-submenu>.dropdown-menu {\n top: 0;\n left: 100%;\n margin-top: -6px;\n margin-left: -1px;\n border-radius: 0 6px 6px 6px;\n}\n\n.dropdown-submenu:hover>.dropdown-menu {\n display: block;\n}\n\n.dropdown-submenu>a:after {\n display: block;\n content: \" \";\n float: right;\n width: 0;\n height: 0;\n border-color: transparent;\n border-style: solid;\n border-width: 5px 0 5px 5px;\n border-left-color: #cccccc;\n margin-top: 5px;\n margin-right: -10px;\n}\n\n.dropdown-submenu:hover>a:after {\n border-left-color: #ffffff;\n}\n\n.dropdown-submenu.pull-left {\n float: none;\n}\n\n.dropdown-submenu.pull-left>.dropdown-menu {\n left: -100%;\n margin-left: 10px;\n border-radius: 6px 0 6px 6px;\n}\n\n/* Sidebar --------------------------*/\n\n#pkgdown-sidebar {\n margin-top: 30px;\n position: -webkit-sticky;\n position: sticky;\n top: 70px;\n}\n\n#pkgdown-sidebar h2 {\n font-size: 1.5em;\n margin-top: 1em;\n}\n\n#pkgdown-sidebar h2:first-child {\n margin-top: 0;\n}\n\n#pkgdown-sidebar .list-unstyled li {\n margin-bottom: 0.5em;\n}\n\n/* bootstrap-toc tweaks ------------------------------------------------------*/\n\n/* All levels of nav */\n\nnav[data-toggle='toc'] .nav > li > a {\n padding: 4px 20px 4px 6px;\n font-size: 1.5rem;\n font-weight: 400;\n color: inherit;\n}\n\nnav[data-toggle='toc'] .nav > li > a:hover,\nnav[data-toggle='toc'] .nav > li > a:focus {\n padding-left: 5px;\n color: inherit;\n border-left: 1px solid #878787;\n}\n\nnav[data-toggle='toc'] .nav > .active > a,\nnav[data-toggle='toc'] .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav > .active:focus > a {\n padding-left: 5px;\n font-size: 1.5rem;\n font-weight: 400;\n color: inherit;\n border-left: 2px solid #878787;\n}\n\n/* Nav: second level (shown on .active) */\n\nnav[data-toggle='toc'] .nav .nav {\n display: none; /* Hide by default, but at >768px, show it */\n padding-bottom: 10px;\n}\n\nnav[data-toggle='toc'] .nav .nav > li > a {\n padding-left: 16px;\n font-size: 1.35rem;\n}\n\nnav[data-toggle='toc'] .nav .nav > li > a:hover,\nnav[data-toggle='toc'] .nav .nav > li > a:focus {\n padding-left: 15px;\n}\n\nnav[data-toggle='toc'] .nav .nav > .active > a,\nnav[data-toggle='toc'] .nav .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav .nav > .active:focus > a {\n padding-left: 15px;\n font-weight: 500;\n font-size: 1.35rem;\n}\n\n/* orcid ------------------------------------------------------------------- */\n\n.orcid {\n font-size: 16px;\n color: #A6CE39;\n /* margins are required by official ORCID trademark and display guidelines */\n margin-left:4px;\n margin-right:4px;\n vertical-align: middle;\n}\n\n/* Reference index & topics ----------------------------------------------- */\n\n.ref-index th {font-weight: normal;}\n\n.ref-index td {vertical-align: top; min-width: 100px}\n.ref-index .icon {width: 40px;}\n.ref-index .alias {width: 40%;}\n.ref-index-icons .alias {width: calc(40% - 40px);}\n.ref-index .title {width: 60%;}\n\n.ref-arguments th {text-align: right; padding-right: 10px;}\n.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}\n.ref-arguments .name {width: 20%;}\n.ref-arguments .desc {width: 80%;}\n\n/* Nice scrolling for wide elements --------------------------------------- */\n\ntable {\n display: block;\n overflow: auto;\n}\n\n/* Syntax highlighting ---------------------------------------------------- */\n\npre, code, pre code {\n background-color: #f8f8f8;\n color: #333;\n}\npre, pre code {\n white-space: pre-wrap;\n word-break: break-all;\n overflow-wrap: break-word;\n}\n\npre {\n border: 1px solid #eee;\n}\n\npre .img, pre .r-plt {\n margin: 5px 0;\n}\n\npre .img img, pre .r-plt img {\n background-color: #fff;\n}\n\ncode a, pre a {\n color: #375f84;\n}\n\na.sourceLine:hover {\n text-decoration: none;\n}\n\n.fl {color: #1514b5;}\n.fu {color: #000000;} /* function */\n.ch,.st {color: #036a07;} /* string */\n.kw {color: #264D66;} /* keyword */\n.co {color: #888888;} /* comment */\n\n.error {font-weight: bolder;}\n.warning {font-weight: bolder;}\n\n/* Clipboard --------------------------*/\n\n.hasCopyButton {\n position: relative;\n}\n\n.btn-copy-ex {\n position: absolute;\n right: 0;\n top: 0;\n visibility: hidden;\n}\n\n.hasCopyButton:hover button.btn-copy-ex {\n visibility: visible;\n}\n\n/* headroom.js ------------------------ */\n\n.headroom {\n will-change: transform;\n transition: transform 200ms linear;\n}\n.headroom--pinned {\n transform: translateY(0%);\n}\n.headroom--unpinned {\n transform: translateY(-100%);\n}\n\n/* mark.js ----------------------------*/\n\nmark {\n background-color: rgba(255, 255, 51, 0.5);\n border-bottom: 2px solid rgba(255, 153, 51, 0.3);\n padding: 1px;\n}\n\n/* vertical spacing after htmlwidgets */\n.html-widget {\n margin-bottom: 10px;\n}\n\n/* fontawesome ------------------------ */\n\n.fab {\n font-family: \"Font Awesome 5 Brands\" !important;\n}\n\n/* don't display links in code chunks when printing */\n/* source: https://stackoverflow.com/a/10781533 */\n@media print {\n code a:link:after, code a:visited:after {\n content: \"\";\n }\n}\n\n/* Section anchors ---------------------------------\n Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71\n*/\n\ndiv.csl-bib-body { }\ndiv.csl-entry {\n clear: both;\n}\n.hanging-indent div.csl-entry {\n margin-left:2em;\n text-indent:-2em;\n}\ndiv.csl-left-margin {\n min-width:2em;\n float:left;\n}\ndiv.csl-right-inline {\n margin-left:2em;\n padding-left:1em;\n}\ndiv.csl-indent {\n margin-left: 2em;\n}\n"
},
{
"path": "docs/pkgdown.js",
"content": "/* http://gregfranko.com/blog/jquery-best-practices/ */\n(function($) {\n $(function() {\n\n $('.navbar-fixed-top').headroom();\n\n $('body').css('padding-top', $('.navbar').height() + 10);\n $(window).resize(function(){\n $('body').css('padding-top', $('.navbar').height() + 10);\n });\n\n $('[data-toggle=\"tooltip\"]').tooltip();\n\n var cur_path = paths(location.pathname);\n var links = $(\"#navbar ul li a\");\n var max_length = -1;\n var pos = -1;\n for (var i = 0; i < links.length; i++) {\n if (links[i].getAttribute(\"href\") === \"#\")\n continue;\n // Ignore external links\n if (links[i].host !== location.host)\n continue;\n\n var nav_path = paths(links[i].pathname);\n\n var length = prefix_length(nav_path, cur_path);\n if (length > max_length) {\n max_length = length;\n pos = i;\n }\n }\n\n // Add class to parent
`).\n getTopLevel: function($scope) {\n for (var i = 1; i <= 6; i++) {\n var $headings = this.findOrFilter($scope, 'h' + i);\n if ($headings.length > 1) {\n return i;\n }\n }\n\n return 1;\n },\n\n // returns the elements for the top level, and the next below it\n getHeadings: function($scope, topLevel) {\n var topSelector = 'h' + topLevel;\n\n var secondaryLevel = topLevel + 1;\n var secondarySelector = 'h' + secondaryLevel;\n\n return this.findOrFilter($scope, topSelector + ',' + secondarySelector);\n },\n\n getNavLevel: function(el) {\n return parseInt(el.tagName.charAt(1), 10);\n },\n\n populateNav: function($topContext, topLevel, $headings) {\n var $context = $topContext;\n var $prevNav;\n\n var helpers = this;\n $headings.each(function(i, el) {\n var $newNav = helpers.generateNavItem(el);\n var navLevel = helpers.getNavLevel(el);\n\n // determine the proper $context\n if (navLevel === topLevel) {\n // use top level\n $context = $topContext;\n } else if ($prevNav && $context === $topContext) {\n // create a new level of the tree and switch to it\n $context = helpers.createChildNavList($prevNav);\n } // else use the current $context\n\n $context.append($newNav);\n\n $prevNav = $newNav;\n });\n },\n\n parseOps: function(arg) {\n var opts;\n if (arg.jquery) {\n opts = {\n $nav: arg\n };\n } else {\n opts = arg;\n }\n opts.$scope = opts.$scope || $(document.body);\n return opts;\n }\n },\n\n // accepts a jQuery object, or an options object\n init: function(opts) {\n opts = this.helpers.parseOps(opts);\n\n // ensure that the data attribute is in place for styling\n opts.$nav.attr('data-toggle', 'toc');\n\n var $topContext = this.helpers.createChildNavList(opts.$nav);\n var topLevel = this.helpers.getTopLevel(opts.$scope);\n var $headings = this.helpers.getHeadings(opts.$scope, topLevel);\n this.helpers.populateNav($topContext, topLevel, $headings);\n }\n };\n\n $(function() {\n $('nav[data-toggle=\"toc\"]').each(function(i, el) {\n var $nav = $(el);\n Toc.init($nav);\n });\n });\n})();\n"
},
{
"path": "docs/docsearch.css",
"content": "/* Docsearch -------------------------------------------------------------- */\n/*\n Source: https://github.com/algolia/docsearch/\n License: MIT\n*/\n\n.algolia-autocomplete {\n display: block;\n -webkit-box-flex: 1;\n -ms-flex: 1;\n flex: 1\n}\n\n.algolia-autocomplete .ds-dropdown-menu {\n width: 100%;\n min-width: none;\n max-width: none;\n padding: .75rem 0;\n background-color: #fff;\n background-clip: padding-box;\n border: 1px solid rgba(0, 0, 0, .1);\n box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175);\n}\n\n@media (min-width:768px) {\n .algolia-autocomplete .ds-dropdown-menu {\n width: 175%\n }\n}\n\n.algolia-autocomplete .ds-dropdown-menu::before {\n display: none\n}\n\n.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] {\n padding: 0;\n background-color: rgb(255,255,255);\n border: 0;\n max-height: 80vh;\n}\n\n.algolia-autocomplete .ds-dropdown-menu .ds-suggestions {\n margin-top: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion {\n padding: 0;\n overflow: visible\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--category-header {\n padding: .125rem 1rem;\n margin-top: 0;\n font-size: 1.3em;\n font-weight: 500;\n color: #00008B;\n border-bottom: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--wrapper {\n float: none;\n padding-top: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column {\n float: none;\n width: auto;\n padding: 0;\n text-align: left\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--content {\n float: none;\n width: auto;\n padding: 0\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--content::before {\n display: none\n}\n\n.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header {\n padding-top: .75rem;\n margin-top: .75rem;\n border-top: 1px solid rgba(0, 0, 0, .1)\n}\n\n.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column {\n display: block;\n padding: .1rem 1rem;\n margin-bottom: 0.1;\n font-size: 1.0em;\n font-weight: 400\n /* display: none */\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--title {\n display: block;\n padding: .25rem 1rem;\n margin-bottom: 0;\n font-size: 0.9em;\n font-weight: 400\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--text {\n padding: 0 1rem .5rem;\n margin-top: -.25rem;\n font-size: 0.8em;\n font-weight: 400;\n line-height: 1.25\n}\n\n.algolia-autocomplete .algolia-docsearch-footer {\n width: 110px;\n height: 20px;\n z-index: 3;\n margin-top: 10.66667px;\n float: right;\n font-size: 0;\n line-height: 0;\n}\n\n.algolia-autocomplete .algolia-docsearch-footer--logo {\n background-image: url(\"data:image/svg+xml;utf8,\");\n background-repeat: no-repeat;\n background-position: 50%;\n background-size: 100%;\n overflow: hidden;\n text-indent: -9000px;\n width: 100%;\n height: 100%;\n display: block;\n transform: translate(-8px);\n}\n\n.algolia-autocomplete .algolia-docsearch-suggestion--highlight {\n color: #FF8C00;\n background: rgba(232, 189, 54, 0.1)\n}\n\n\n.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight {\n box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5)\n}\n\n.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content {\n background-color: rgba(192, 192, 192, .15)\n}\n"
},
{
"path": "docs/docsearch.js",
"content": "$(function() {\n\n // register a handler to move the focus to the search bar\n // upon pressing shift + \"/\" (i.e. \"?\")\n $(document).on('keydown', function(e) {\n if (e.shiftKey && e.keyCode == 191) {\n e.preventDefault();\n $(\"#search-input\").focus();\n }\n });\n\n $(document).ready(function() {\n // do keyword highlighting\n /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */\n var mark = function() {\n\n var referrer = document.URL ;\n var paramKey = \"q\" ;\n\n if (referrer.indexOf(\"?\") !== -1) {\n var qs = referrer.substr(referrer.indexOf('?') + 1);\n var qs_noanchor = qs.split('#')[0];\n var qsa = qs_noanchor.split('&');\n var keyword = \"\";\n\n for (var i = 0; i < qsa.length; i++) {\n var currentParam = qsa[i].split('=');\n\n if (currentParam.length !== 2) {\n continue;\n }\n\n if (currentParam[0] == paramKey) {\n keyword = decodeURIComponent(currentParam[1].replace(/\\+/g, \"%20\"));\n }\n }\n\n if (keyword !== \"\") {\n $(\".contents\").unmark({\n done: function() {\n $(\".contents\").mark(keyword);\n }\n });\n }\n }\n };\n\n mark();\n });\n});\n\n/* Search term highlighting ------------------------------*/\n\nfunction matchedWords(hit) {\n var words = [];\n\n var hierarchy = hit._highlightResult.hierarchy;\n // loop to fetch from lvl0, lvl1, etc.\n for (var idx in hierarchy) {\n words = words.concat(hierarchy[idx].matchedWords);\n }\n\n var content = hit._highlightResult.content;\n if (content) {\n words = words.concat(content.matchedWords);\n }\n\n // return unique words\n var words_uniq = [...new Set(words)];\n return words_uniq;\n}\n\nfunction updateHitURL(hit) {\n\n var words = matchedWords(hit);\n var url = \"\";\n\n if (hit.anchor) {\n url = hit.url_without_anchor + '?q=' + escape(words.join(\" \")) + '#' + hit.anchor;\n } else {\n url = hit.url + '?q=' + escape(words.join(\" \"));\n }\n\n return url;\n}\n"
},
{
"path": "docs/index.html",
"content": "\n\n\n\n\n\n\nInteract with carbon.js • carbonate \n\n\n\n\n\n\n\n\n\n\n \n\n \n \n\n\n \n\n \n \n\n\n“carbon.js is the easiest way to create beautiful images of your source code.”
\nThis package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
\nLike the image below:
\n
\n\nInstallation\n
\n\n#remotes::install_github('yonicd/carbonate')\ninstall.packages('carbonate')
\n\n\nUsage\n
\n\nInitialize new carbon object\n
\n\nThe default code in the carbon object is taken from the clipboard.
\n\nx <- carbon$new()
\nBut can also be defined inline. Code can be a character object of any length.
\n\nThe code is kept in the object and can be changed at any time.
\n\nx$code\n#> [1] \"Package: carbonate\" \n#> [2] \"Title: Interact with 'carbon.js'\" \n#> [3] \"Version: 0.2.0\" \n#> [4] \"Authors@R: \" \n#> [5] \" person(given = \\\"Jonathan\\\",\" \n#> [6] \" family = \\\"Sidi\\\",\" \n#> [7] \" role = c(\\\"aut\\\", \\\"cre\\\"),\" \n#> [8] \" email = \\\"yonicd@gmail.com\\\",\" \n#> [9] \" comment = c(ORCID = \\\"0000-0002-4222-1819\\\"))\" \n#> [10] \"Description: Create beautiful images of source code using\" \n#> [11] \" 'carbon.js'<https://carbon.now.sh/about>.\" \n#> [12] \"License: MIT + file LICENSE\" \n#> [13] \"URL: https://github.com/yonicd/carbonate\" \n#> [14] \"BugReports: https://github.com/yonicd/carbonate/issues\" \n#> [15] \"Depends: \" \n#> [16] \" R (>= 3.2.0)\" \n#> [17] \"Imports: \" \n#> [18] \" clipr,\" \n#> [19] \" details,\" \n#> [20] \" httpuv,\" \n#> [21] \" httr,\" \n#> [22] \" magick,\" \n#> [23] \" R6,\" \n#> [24] \" reprex,\" \n#> [25] \" RSelenium,\" \n#> [26] \" rtweet,\" \n#> [27] \" utils,\" \n#> [28] \" wdman,\" \n#> [29] \" jsonlite,\" \n#> [30] \" yaml\" \n#> [31] \"Suggests: \" \n#> [32] \" covr,\" \n#> [33] \" knitr,\" \n#> [34] \" rmarkdown,\" \n#> [35] \" testthat\" \n#> [36] \"VignetteBuilder: \" \n#> [37] \" knitr\" \n#> [38] \"RdMacros: \" \n#> [39] \" details\" \n#> [40] \"Encoding: UTF-8\" \n#> [41] \"LazyData: true\" \n#> [42] \"Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)\"\n#> [43] \"RoxygenNote: 7.2.1\"
\nThe 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.
\n\nx$uri()\n#> [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\"
\nClick the link to see the URI works.
\n\n\nManipulate carbon object\n
\nAesthetics of the carbon object that can be manipulated
\n\n\n \n\nCarbon Variable \nCarbonate Variable \nDescription \nDefault \n \n\n\nl \nlanguage \nlanguage \nr \n \n\nbg \npalette \nlayout pallete (vector with c(r,g,b,a) \nc(r=171,g=184,b=195,a=1) \n \n\nt \ntemplate \nlayout template (listed in get_templates()) \n‘seti’ \n \n\nwc \nadd_window_control \nadd/remove window controls (circles on top left corner) \nTRUE \n \n\nwt \nwindow_control_theme \nchange window control themes (listed in get_windows_control_themes()) \n‘none’ \n \n\nds \nadd_drop_shadow \nadd/remove dropshadow \nTRUE \n \n\ndsyoff \ndrop_shadow_offset_y \nshadow vertical offset (px) \n20 \n \n\ndsblur \ndrop_shadow_blur_radius \nshadow blur radius (px) \n68 \n \n\nwa \nauto_adjust_width \nauto-audjust output width \nTRUE \n \n\npv \npadding_vertical \nvertical padding (px) \n48 \n \n\nph \npadding_horizontal \nhorizontal padding (px) \n32 \n \n\nln \nadd_line_number \nadd/remove line numbers \nFALSE \n \n\nfm \nfont_family \nlayout font family (listed in get_font_families()) \n‘Hack’ \n \n\nfs \nfont_size \nfont size (px) \n14 \n \n\nlh \nline_height_percent \nrelative space between lines (percent) \n133 \n \n\nsi \nsquare_image \noutput image is square \nFALSE \n \n\nes \nrelative_export_size \nimage size in export relative to what is in the preview (1,2 or 4) \n1 \n \n\nwm \nadd_watermark \nadd official carbon.js watermark \nFALSE \n \n\n
\n\nx$get_templates()\n#> [1] \"3024-night\" \"a11y-dark\" \"blackboard\" \n#> [4] \"base16-dark\" \"base16-light\" \"cobalt\" \n#> [7] \"dracula\" \"duotone-dark\" \"hopscotch\" \n#> [10] \"lucario\" \"material\" \"monokai\" \n#> [13] \"night-owl\" \"nord\" \"oceanic-next\" \n#> [16] \"one-light\" \"one-dark\" \"panda-syntax\" \n#> [19] \"paraiso-dark\" \"seti\" \"shades-of-purple\"\n#> [22] \"solarized dark\" \"solarized light\" \"synthwave-84\" \n#> [25] \"twilight\" \"verminal\" \"vscode\" \n#> [28] \"yeti\" \"zenburn\"
\n\nx$get_font_families()\n#> [1] \"Anonymous Pro\" \"Cascadia Code\" \"Droid Sans Mono\" \n#> [4] \"Fantasque Sans Mono\" \"Fira Code\" \"Hack\" \n#> [7] \"IBM Plex Mono\" \"Inconsolata\" \"JetBrains Mono\" \n#> [10] \"Monoid\" \"Source Code Pro\" \"Space Mono\" \n#> [13] \"Ubuntu Mono\"
\n\nx$get_windows_control_themes()\n#> [1] \"none\" \"sharp\" \"bw\"
\n\n\nPersonal Configuration\n
\nUsers 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.
\nThese fields will set
\n\n- The palette (rgba)
g and a fields to 175 and 0.7 respectively \n- The template will be set to
panda-syntax\n \n- The font to
Fira Code\n \n- The padding around the output will be made tighter than the system defaults 11px and 14px.
\n
\n\n\n\n\nSet the download directory\n
\n\nx$download_path <- file.path('README_files/download')
\n\n\nCarbonate code directly to file\n
\nThis function depends on RSelenium
\n\nx$carbonate(file = 'myfile.png')
\n
\n\nx$template <-'cobalt'\nx$carbonate(file = 'new_template.png')
\n
\n\nx$font_family <-'IBM Plex Mono'\nx$carbonate(file = 'new_font.png')
\n
\n\n\n\n\nSharing\n
\n\nTinyurl\n
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.
\n\nx$add_tinyurl <- TRUE\nx$carbonate(file = 'tiny_url.png')
\n
\nIf you just want the tinyurl link without the image to use in a tweet you can create it using
\n\nx$tiny()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"
\nOr you can put the link directly on your clipboard
\n\nx$tiny(clip = TRUE)\n#> [1] \"https://tinyurl.com/2kvjyzlx\"\nclipr::read_clip()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"
\n\nTwitter\n
\nDirect\n
\nYou can also directly tweet the image. An automatic status is created with two options
\n\n- Default\n
\n- Created in R using the Carbonate 📦
\n
\n \n- When
add_tinyurl <- TRUE\n\n- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx\n
\n
\n \n- Manual\n
\n- Using
tweet_status you can write your own status. \n
\n \n
\n\nx <- carbonate::carbon$new()\nx$tweet <- TRUE\nx$carbonate()
\n\n\nPost process (Batch)\n
\nIf you have images stored in x$carbons you can post them also in a tweet using.
\n\n# for multiple png attachments\nx$rtweet(x$carbons,media_type = 'png') #using default status\n\n# subsets of images\nx$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')\n\n# for gifs\nx$rtweet(status='This is a gif', x$carbons,media_type = 'gif')
\n\n\n\n\n\nPost image processing\n
\nAll carbon outputs are collected and saved in the list x$carbons
\n\nCombining\n
\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append()
\n
\n\n\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append(stack = TRUE)
\n
\n\n\n\n\n \n\n \n\n\n\n \n\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/pkgdown.css",
"content": "/* Sticky footer */\n\n/**\n * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/\n * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css\n *\n * .Site -> body > .container\n * .Site-content -> body > .container .row\n * .footer -> footer\n *\n * Key idea seems to be to ensure that .container and __all its parents__\n * have height set to 100%\n *\n */\n\nhtml, body {\n height: 100%;\n}\n\nbody {\n position: relative;\n}\n\nbody > .container {\n display: flex;\n height: 100%;\n flex-direction: column;\n}\n\nbody > .container .row {\n flex: 1 0 auto;\n}\n\nfooter {\n margin-top: 45px;\n padding: 35px 0 36px;\n border-top: 1px solid #e5e5e5;\n color: #666;\n display: flex;\n flex-shrink: 0;\n}\nfooter p {\n margin-bottom: 0;\n}\nfooter div {\n flex: 1;\n}\nfooter .pkgdown {\n text-align: right;\n}\nfooter p {\n margin-bottom: 0;\n}\n\nimg.icon {\n float: right;\n}\n\n/* Ensure in-page images don't run outside their container */\n.contents img {\n max-width: 100%;\n height: auto;\n}\n\n/* Fix bug in bootstrap (only seen in firefox) */\nsummary {\n display: list-item;\n}\n\n/* Typographic tweaking ---------------------------------*/\n\n.contents .page-header {\n margin-top: calc(-60px + 1em);\n}\n\ndd {\n margin-left: 3em;\n}\n\n/* Section anchors ---------------------------------*/\n\na.anchor {\n display: none;\n margin-left: 5px;\n width: 20px;\n height: 20px;\n\n background-image: url(./link.svg);\n background-repeat: no-repeat;\n background-size: 20px 20px;\n background-position: center center;\n}\n\nh1:hover .anchor,\nh2:hover .anchor,\nh3:hover .anchor,\nh4:hover .anchor,\nh5:hover .anchor,\nh6:hover .anchor {\n display: inline-block;\n}\n\n/* Fixes for fixed navbar --------------------------*/\n\n.contents h1, .contents h2, .contents h3, .contents h4 {\n padding-top: 60px;\n margin-top: -40px;\n}\n\n/* Navbar submenu --------------------------*/\n\n.dropdown-submenu {\n position: relative;\n}\n\n.dropdown-submenu>.dropdown-menu {\n top: 0;\n left: 100%;\n margin-top: -6px;\n margin-left: -1px;\n border-radius: 0 6px 6px 6px;\n}\n\n.dropdown-submenu:hover>.dropdown-menu {\n display: block;\n}\n\n.dropdown-submenu>a:after {\n display: block;\n content: \" \";\n float: right;\n width: 0;\n height: 0;\n border-color: transparent;\n border-style: solid;\n border-width: 5px 0 5px 5px;\n border-left-color: #cccccc;\n margin-top: 5px;\n margin-right: -10px;\n}\n\n.dropdown-submenu:hover>a:after {\n border-left-color: #ffffff;\n}\n\n.dropdown-submenu.pull-left {\n float: none;\n}\n\n.dropdown-submenu.pull-left>.dropdown-menu {\n left: -100%;\n margin-left: 10px;\n border-radius: 6px 0 6px 6px;\n}\n\n/* Sidebar --------------------------*/\n\n#pkgdown-sidebar {\n margin-top: 30px;\n position: -webkit-sticky;\n position: sticky;\n top: 70px;\n}\n\n#pkgdown-sidebar h2 {\n font-size: 1.5em;\n margin-top: 1em;\n}\n\n#pkgdown-sidebar h2:first-child {\n margin-top: 0;\n}\n\n#pkgdown-sidebar .list-unstyled li {\n margin-bottom: 0.5em;\n}\n\n/* bootstrap-toc tweaks ------------------------------------------------------*/\n\n/* All levels of nav */\n\nnav[data-toggle='toc'] .nav > li > a {\n padding: 4px 20px 4px 6px;\n font-size: 1.5rem;\n font-weight: 400;\n color: inherit;\n}\n\nnav[data-toggle='toc'] .nav > li > a:hover,\nnav[data-toggle='toc'] .nav > li > a:focus {\n padding-left: 5px;\n color: inherit;\n border-left: 1px solid #878787;\n}\n\nnav[data-toggle='toc'] .nav > .active > a,\nnav[data-toggle='toc'] .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav > .active:focus > a {\n padding-left: 5px;\n font-size: 1.5rem;\n font-weight: 400;\n color: inherit;\n border-left: 2px solid #878787;\n}\n\n/* Nav: second level (shown on .active) */\n\nnav[data-toggle='toc'] .nav .nav {\n display: none; /* Hide by default, but at >768px, show it */\n padding-bottom: 10px;\n}\n\nnav[data-toggle='toc'] .nav .nav > li > a {\n padding-left: 16px;\n font-size: 1.35rem;\n}\n\nnav[data-toggle='toc'] .nav .nav > li > a:hover,\nnav[data-toggle='toc'] .nav .nav > li > a:focus {\n padding-left: 15px;\n}\n\nnav[data-toggle='toc'] .nav .nav > .active > a,\nnav[data-toggle='toc'] .nav .nav > .active:hover > a,\nnav[data-toggle='toc'] .nav .nav > .active:focus > a {\n padding-left: 15px;\n font-weight: 500;\n font-size: 1.35rem;\n}\n\n/* orcid ------------------------------------------------------------------- */\n\n.orcid {\n font-size: 16px;\n color: #A6CE39;\n /* margins are required by official ORCID trademark and display guidelines */\n margin-left:4px;\n margin-right:4px;\n vertical-align: middle;\n}\n\n/* Reference index & topics ----------------------------------------------- */\n\n.ref-index th {font-weight: normal;}\n\n.ref-index td {vertical-align: top; min-width: 100px}\n.ref-index .icon {width: 40px;}\n.ref-index .alias {width: 40%;}\n.ref-index-icons .alias {width: calc(40% - 40px);}\n.ref-index .title {width: 60%;}\n\n.ref-arguments th {text-align: right; padding-right: 10px;}\n.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px}\n.ref-arguments .name {width: 20%;}\n.ref-arguments .desc {width: 80%;}\n\n/* Nice scrolling for wide elements --------------------------------------- */\n\ntable {\n display: block;\n overflow: auto;\n}\n\n/* Syntax highlighting ---------------------------------------------------- */\n\npre, code, pre code {\n background-color: #f8f8f8;\n color: #333;\n}\npre, pre code {\n white-space: pre-wrap;\n word-break: break-all;\n overflow-wrap: break-word;\n}\n\npre {\n border: 1px solid #eee;\n}\n\npre .img, pre .r-plt {\n margin: 5px 0;\n}\n\npre .img img, pre .r-plt img {\n background-color: #fff;\n}\n\ncode a, pre a {\n color: #375f84;\n}\n\na.sourceLine:hover {\n text-decoration: none;\n}\n\n.fl {color: #1514b5;}\n.fu {color: #000000;} /* function */\n.ch,.st {color: #036a07;} /* string */\n.kw {color: #264D66;} /* keyword */\n.co {color: #888888;} /* comment */\n\n.error {font-weight: bolder;}\n.warning {font-weight: bolder;}\n\n/* Clipboard --------------------------*/\n\n.hasCopyButton {\n position: relative;\n}\n\n.btn-copy-ex {\n position: absolute;\n right: 0;\n top: 0;\n visibility: hidden;\n}\n\n.hasCopyButton:hover button.btn-copy-ex {\n visibility: visible;\n}\n\n/* headroom.js ------------------------ */\n\n.headroom {\n will-change: transform;\n transition: transform 200ms linear;\n}\n.headroom--pinned {\n transform: translateY(0%);\n}\n.headroom--unpinned {\n transform: translateY(-100%);\n}\n\n/* mark.js ----------------------------*/\n\nmark {\n background-color: rgba(255, 255, 51, 0.5);\n border-bottom: 2px solid rgba(255, 153, 51, 0.3);\n padding: 1px;\n}\n\n/* vertical spacing after htmlwidgets */\n.html-widget {\n margin-bottom: 10px;\n}\n\n/* fontawesome ------------------------ */\n\n.fab {\n font-family: \"Font Awesome 5 Brands\" !important;\n}\n\n/* don't display links in code chunks when printing */\n/* source: https://stackoverflow.com/a/10781533 */\n@media print {\n code a:link:after, code a:visited:after {\n content: \"\";\n }\n}\n\n/* Section anchors ---------------------------------\n Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71\n*/\n\ndiv.csl-bib-body { }\ndiv.csl-entry {\n clear: both;\n}\n.hanging-indent div.csl-entry {\n margin-left:2em;\n text-indent:-2em;\n}\ndiv.csl-left-margin {\n min-width:2em;\n float:left;\n}\ndiv.csl-right-inline {\n margin-left:2em;\n padding-left:1em;\n}\ndiv.csl-indent {\n margin-left: 2em;\n}\n"
},
{
"path": "docs/pkgdown.js",
"content": "/* http://gregfranko.com/blog/jquery-best-practices/ */\n(function($) {\n $(function() {\n\n $('.navbar-fixed-top').headroom();\n\n $('body').css('padding-top', $('.navbar').height() + 10);\n $(window).resize(function(){\n $('body').css('padding-top', $('.navbar').height() + 10);\n });\n\n $('[data-toggle=\"tooltip\"]').tooltip();\n\n var cur_path = paths(location.pathname);\n var links = $(\"#navbar ul li a\");\n var max_length = -1;\n var pos = -1;\n for (var i = 0; i < links.length; i++) {\n if (links[i].getAttribute(\"href\") === \"#\")\n continue;\n // Ignore external links\n if (links[i].host !== location.host)\n continue;\n\n var nav_path = paths(links[i].pathname);\n\n var length = prefix_length(nav_path, cur_path);\n if (length > max_length) {\n max_length = length;\n pos = i;\n }\n }\n\n // Add class to parent
\n
\n\n\n \n\n\n\n
\n\n \n“carbon.js is the easiest way to create beautiful images of your source code.”
\nThis package uses an R6 api to interact with carbon.js and create directly from the console carbon images.
Like the image below:
\n
\n\n
\nInstallation\n
\n\n#remotes::install_github('yonicd/carbonate')\ninstall.packages('carbonate')\n
\n\n Usage\n
\n\n\n\n\n
\nInitialize new carbon object\n
\n\nThe default code in the carbon object is taken from the clipboard.
\n\nx <- carbon$new()But can also be defined inline. Code can be a character object of any length.
\n\nThe code is kept in the object and can be changed at any time.
\n\nx$code\n#> [1] \"Package: carbonate\" \n#> [2] \"Title: Interact with 'carbon.js'\" \n#> [3] \"Version: 0.2.0\" \n#> [4] \"Authors@R: \" \n#> [5] \" person(given = \\\"Jonathan\\\",\" \n#> [6] \" family = \\\"Sidi\\\",\" \n#> [7] \" role = c(\\\"aut\\\", \\\"cre\\\"),\" \n#> [8] \" email = \\\"yonicd@gmail.com\\\",\" \n#> [9] \" comment = c(ORCID = \\\"0000-0002-4222-1819\\\"))\" \n#> [10] \"Description: Create beautiful images of source code using\" \n#> [11] \" 'carbon.js'<https://carbon.now.sh/about>.\" \n#> [12] \"License: MIT + file LICENSE\" \n#> [13] \"URL: https://github.com/yonicd/carbonate\" \n#> [14] \"BugReports: https://github.com/yonicd/carbonate/issues\" \n#> [15] \"Depends: \" \n#> [16] \" R (>= 3.2.0)\" \n#> [17] \"Imports: \" \n#> [18] \" clipr,\" \n#> [19] \" details,\" \n#> [20] \" httpuv,\" \n#> [21] \" httr,\" \n#> [22] \" magick,\" \n#> [23] \" R6,\" \n#> [24] \" reprex,\" \n#> [25] \" RSelenium,\" \n#> [26] \" rtweet,\" \n#> [27] \" utils,\" \n#> [28] \" wdman,\" \n#> [29] \" jsonlite,\" \n#> [30] \" yaml\" \n#> [31] \"Suggests: \" \n#> [32] \" covr,\" \n#> [33] \" knitr,\" \n#> [34] \" rmarkdown,\" \n#> [35] \" testthat\" \n#> [36] \"VignetteBuilder: \" \n#> [37] \" knitr\" \n#> [38] \"RdMacros: \" \n#> [39] \" details\" \n#> [40] \"Encoding: UTF-8\" \n#> [41] \"LazyData: true\" \n#> [42] \"Roxygen: list(markdown = TRUE,old_usage = TRUE,r6 = FALSE)\"\n#> [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.
\n\nx$uri()\n#> [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.
\n\n\n
\n\n\n\n
\nManipulate carbon object\n
\nAesthetics of the carbon object that can be manipulated
\n| Carbon Variable | \nCarbonate Variable | \nDescription | \nDefault | \n
|---|---|---|---|
| l | \nlanguage | \nlanguage | \nr | \n
| bg | \npalette | \nlayout pallete (vector with c(r,g,b,a) | \nc(r=171,g=184,b=195,a=1) | \n
| t | \ntemplate | \nlayout template (listed in get_templates()) | \n‘seti’ | \n
| wc | \nadd_window_control | \nadd/remove window controls (circles on top left corner) | \nTRUE | \n
| wt | \nwindow_control_theme | \nchange window control themes (listed in get_windows_control_themes()) | \n‘none’ | \n
| ds | \nadd_drop_shadow | \nadd/remove dropshadow | \nTRUE | \n
| dsyoff | \ndrop_shadow_offset_y | \nshadow vertical offset (px) | \n20 | \n
| dsblur | \ndrop_shadow_blur_radius | \nshadow blur radius (px) | \n68 | \n
| wa | \nauto_adjust_width | \nauto-audjust output width | \nTRUE | \n
| pv | \npadding_vertical | \nvertical padding (px) | \n48 | \n
| ph | \npadding_horizontal | \nhorizontal padding (px) | \n32 | \n
| ln | \nadd_line_number | \nadd/remove line numbers | \nFALSE | \n
| fm | \nfont_family | \nlayout font family (listed in get_font_families()) | \n‘Hack’ | \n
| fs | \nfont_size | \nfont size (px) | \n14 | \n
| lh | \nline_height_percent | \nrelative space between lines (percent) | \n133 | \n
| si | \nsquare_image | \noutput image is square | \nFALSE | \n
| es | \nrelative_export_size | \nimage size in export relative to what is in the preview (1,2 or 4) | \n1 | \n
| wm | \nadd_watermark | \nadd official carbon.js watermark | \nFALSE | \n
\nx$get_templates()\n#> [1] \"3024-night\" \"a11y-dark\" \"blackboard\" \n#> [4] \"base16-dark\" \"base16-light\" \"cobalt\" \n#> [7] \"dracula\" \"duotone-dark\" \"hopscotch\" \n#> [10] \"lucario\" \"material\" \"monokai\" \n#> [13] \"night-owl\" \"nord\" \"oceanic-next\" \n#> [16] \"one-light\" \"one-dark\" \"panda-syntax\" \n#> [19] \"paraiso-dark\" \"seti\" \"shades-of-purple\"\n#> [22] \"solarized dark\" \"solarized light\" \"synthwave-84\" \n#> [25] \"twilight\" \"verminal\" \"vscode\" \n#> [28] \"yeti\" \"zenburn\"\nx$get_font_families()\n#> [1] \"Anonymous Pro\" \"Cascadia Code\" \"Droid Sans Mono\" \n#> [4] \"Fantasque Sans Mono\" \"Fira Code\" \"Hack\" \n#> [7] \"IBM Plex Mono\" \"Inconsolata\" \"JetBrains Mono\" \n#> [10] \"Monoid\" \"Source Code Pro\" \"Space Mono\" \n#> [13] \"Ubuntu Mono\"\nx$get_windows_control_themes()\n#> [1] \"none\" \"sharp\" \"bw\"\n
\n\nPersonal Configuration\n
\nUsers 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
\n- \n
- The palette (rgba)
gandafields to 175 and 0.7 respectively \n - The template will be set to
panda-syntax\n \n - The font to
Fira Code\n \n - The padding around the output will be made tighter than the system defaults 11px and 14px. \n
\n\n
\nSet the download directory\n
\n\nx$download_path <- file.path('README_files/download')\n\n\n\n
\n\n\nCarbonate code directly to file\n
\nThis function depends on RSelenium
\n\nx$carbonate(file = 'myfile.png')
\nx$template <-'cobalt'\nx$carbonate(file = 'new_template.png')
\nx$font_family <-'IBM Plex Mono'\nx$carbonate(file = 'new_font.png')
\n\n\n\n\n
\nSharing\n
\n\nTinyurl\n
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.
\n\nx$add_tinyurl <- TRUE\nx$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
\n\nx$tiny()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"Or you can put the link directly on your clipboard
\n\nx$tiny(clip = TRUE)\n#> [1] \"https://tinyurl.com/2kvjyzlx\"\nclipr::read_clip()\n#> [1] \"https://tinyurl.com/2kvjyzlx\"\nTwitter\n
\n\n
\nDirect\n
\nYou can also directly tweet the image. An automatic status is created with two options
\n- \n
- Default\n
- \n
- Created in R using the Carbonate 📦 \n
\n - When
add_tinyurl <- TRUE\n- \n
- Created in R using the Carbonate 📦 Check out this script at 🔗 https://tinyurl.com/2kvjyzlx\n \n
\n - Manual\n
- \n
- Using
tweet_statusyou can write your own status. \n
\n - Using
\nx <- carbonate::carbon$new()\nx$tweet <- TRUE\nx$carbonate()\n\n\n
\nPost process (Batch)\n
\nIf you have images stored in x$carbons you can post them also in a tweet using.
\n# for multiple png attachments\nx$rtweet(x$carbons,media_type = 'png') #using default status\n\n# subsets of images\nx$rtweet(status='These are images',x$carbons[c(1,3)],media_type = 'png')\n\n# for gifs\nx$rtweet(status='This is a gif', x$carbons,media_type = 'gif')\n\n\n\n
\nPost image processing\n
\nAll carbon outputs are collected and saved in the list x$carbons
\nCombining\n
\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append()
\n\nx$carbons%>%\n magick::image_scale('300')%>%\n magick::image_append(stack = TRUE)
![](\"reference/figures/unnamed-chunk-29-1.gif\")
![\"Travis-CI](\"https://travis-ci.org/yonicd/carbonate.svg?branch=master\")
![\"Coverage](\"https://img.shields.io/codecov/c/github/yonicd/carbonate/master.svg\")
![\"Covrpage](\"https://img.shields.io/badge/covrpage-Last_Build_2022_08_21-yellowgreen.svg\"){kind=icon}
\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbon.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n opens the uri address in $uri in the browser window.
\n\n \n
\n\n .browse(self, private)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n
\n
\n\n See also
\n \n\n \n
\n Examples
\nx <- carbon$new('x <- 1')\n#> Set via '~/carbon.yml'\n#> palette:\n#> - 171.0\n#> - 175.0\n#> - 195.0\n#> - 0.7\n#> template: panda-syntax\n#> font_family: Fira Code\n#> padding_vertical: 11\n#> padding_horizontal: 14\n#> language: r\nif(interactive())\n x$browse()\n\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbon_chrome.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n\n The Carbon generator creates a new Carbon-object, which is the class containing\nall the app logic. The class is based on the R6 OO-system and\nis thus reference-based with methods and data attached to each object, in\ncontrast to the more well known S3 and S4 systems.
\n
\n Initialization
\n \n\nA new 'Carbon'-object is initialized using the new() method on the generator:
x <- carbon$new(code = clipr::read_clip()) |
\n
\n Fields
\n \n\n\n Public Fields
Description of fields of the R6 object that can be set by the user can be found\nin the following page.
\n\n\n
\n
\n
\n
\n
\n\n Methods
\n \n\n\n 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 |
\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbon_fields.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n Functions to open,close,set chrome webdriver
\n\n \n
\n\n .chromeOptions(self, private)\n
\n \n\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n
\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbon_gecko.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n\n Fields that can be changed in the Carbon object
\n\n
\n Arguments
\n- code \n
character, script to embbed, Default: NULL
\n\n\n- palette \n
numeric, layout pallete, Default: c(r=171,g=184,b=195,a=1)
\n\n\n- template \n
character, layout template, Default: 'seti'
\n\n\n- add_window_control \n
boolean, add/remove window controls (circles on top left corner),\nDefault: TRUE
\n\n\n- window_control_theme \n
character, change window control themes, Default: 'none'
\n\n\n- language \n
character, language, Default: 'r'
\n\n\n- add_drop_shadow \n
boolean, add/remove dropshadow, Default: TRUE
\n\n\n- drop_shadow_offset_y \n
numeric, shadow vertical offset (px), Default: 20
\n\n\n- drop_shadow_blur_radius \n
numeric, shadow blur radius (px), Default: 68
\n\n\n- auto_adjust_width \n
boolean, auto-audjust output width, Default: TRUE
\n\n\n- padding_vertical \n
numeric, vertical padding (px), Default: 48
\n\n\n- padding_horizontal \n
numeric, horizontal padding (px), Default: 32
\n\n\n- add_line_number \n
boolean, add/remove line numbers, Default: FALSE
\n\n\n- font_family \n
character, layout font family, Default: 'Hack'
\n\n\n- font_size \n
numeric, font size (px), Default: 14
\n\n\n- line_height_percent \n
numeric, relative space between lines (percent), Default: 133
\n\n\n- square_image \n
boolean, output image is square, Default: FALSE
\n\n\n- relative_export_size \n
numeric, image size in export relative to what is in\nthe preview (1,2 or 4), Default: 1
\n\n\n- add_watermark \n
boolean, add official carbon.js watermark, Default: FALSE
\n\n\n- add_tinyurl \n
boolean, add tinyurl link to image directing to the carbon page that\ncreated the image, Default: FALSE
\n\n\n- tinyurl_location \n
character, string with gravity value to place the annotate tinyurl\naddress on image, Default: 'southeast'
\n\n\n- tweet \n
boolean, tweet out the image using post_tweet
\n\n\n- tweet_status \n
character, status to add to the tweet. If add_tinyurl is TRUE then\na link to the url will be appended to the status automatically,\nDefault: 'Created in R using the Carbonate (Package Icon)'
\n\n\n- add_timestamp \n
boolean, add timestamp to output filename, Default: FALSE
\n\n\n- carbons \n
list, storage of rendered carbon images, Default: NULL
\n\n\n- download_path \n
character, path to download the images, Default: tempdir()
\n\n\n- chrome_args \n
character, arguments passed to chrome browser, Default:\nc('--disable-gpu', '--window-size=1280,800')
\n\n\n- chrome_pref \n
list, preferences passed to chrome browser, Default:\nlist(\"profile.default_content_settings.popups\" = 0L,\"download.prompt_for_download\" = FALSE,\"download.default_directory\" = tempdir())
\n\n\n- rD \n
RSelenium Driver object
\n\n\n- cDrv \n
Chrome Driver object from wdman
\n\n
\n
\n\n See also
\n \n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbon_selenium.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n Functions to open,close,set gecko webdriver
\n\n \n
\n\n .firefoxOptions(self, private)\n
\n \n\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n
\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/carbonate.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n Functions to open,stop, stop_all RSelenium sessions
\n\n \n
\n\n \n
\n Arguments
\n\n
\n\n See also
\n \n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/encode.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n Main function of the package that invokes RSelenium to open\na browser to the carbon.js uri, create an image and download the file.
\n\n \n
\n\n .carbonate(self, private, file, path, code, rD, driver)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- file \n
character, name of file to save image as
\n\n\n- path \n
character, path to save the image
\n\n\n- code \n
character, lines of script to make carbon image from
\n\n\n- rD \n
RSelenium driver
\n\n\n- driver \n
character, select either 'firefox' or 'chrome' driver
\n\n
\n
\n Value
\n \n\nimage object
\n\n
\n \n\n Details
\nScript is passed to https://carbon.now.sh/ is downloaded to the tempdir() and appended to the list $carbons using RSelenium and Chrome.
\n \n
\n Examples
\nif(interactive()){\n x <- carbon$new('x <- 1')\n x$carbonate()\n }\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/get_carbon.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n encode uri string for carbon.js.\nAugmented version of than URLencode
\n\n \n
\n\n .encode(self, private, URL, reserved, repeated)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- URL \n
character, uri string to url encode
\n\n\n- reserved \n
boolean, should ‘reserved’ characters be encoded?
\n\n\n- repeated \n
boolean, should apparently already-encoded URLs be encoded again?
\n\n
\n
\n \n\n Value
\n \n\ncharacter
\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/index.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n function that gets the available list of aesthetic values of fields
\n\n \n
\n\n .get_windows_control_themes(self, private)\n\n.get_font_families(self, private)\n\n.get_templates(self, private)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n
\n
\n\n See also
\n \n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/options.html",
"content": "\n\n
\n\n\n \n
\n\n \n
\n\n Reference
\n\n All functions\n \n | \n |
|---|---|
| \n \n | \nopen $uri to in browser window | \n
| \n \n | \nCarbon R6 class | \n
| \n \n | \nchrome webdriver functions | \n
| \n \n | \nCarbon object fields | \n
| \n \n | \ngecko webdriver functions | \n
| \n
| \n RSelenium webdriver functions | \n
| \n \n | \nCarbonate script lines to a carbon image | \n
| \n \n | \nencode uri for carbon.js | \n
| \n
| \n carbon get functions | \n
| \n \n | \nconcatenate the carbon options to a string | \n
| \n \n | \nCreates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon | \n
| \n \n | \nsend tweets using carbonate outputs | \n
| \n
| \n carbon set functions | \n
| \n \n | \nconvert carbon uri to tinyurl | \n
| \n \n | \nconvert uri to tinyurl | \n
| \n \n | \nURI constructor | \n
\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/reprex_to_carbon_browser.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n combine all the carbon options into a carbon.js valid string
\n\n \n
\n\n .options(self, private, code)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- code \n
character, script to embbed into the uri
\n\n
\n
\n Value
\n \n\nOUTPUT_DESCRIPTION
\n\n
\n\n See also
\n \n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/rtweet.html",
"content": "\n\n
\n\n\n \n
\n \n \n
\n\n Creates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon
\n Source:R/addins.R\n reprex_to_carbon_browser.Rd\n
\n\n Creates a Reprex of selected code (or from input) renders it and opens or downloads the Carbon
\n\n \n
\n\n reprex_to_carbon_browser(..., html_preview = FALSE, style = TRUE,\n url_only = FALSE)\n\nreprex_to_carbon_download(..., file = \"carbon_reprex.png\",\n html_preview = FALSE, style = TRUE, url_only = FALSE)\n
\n Arguments
\n- ... \n
arguments passed to reprex::reprex
\n\n\n- html_preview \n
show also reprex html result? Default is false
\n\n\n- style \n
should the code be styled? Default is True
\n\n\n- url_only \n
if only the URL should be returned without opening the browser
\n\n
\n
\n Value
\n \n\nthe URL to the Carbon (invisible) or the filename (invisible)
\n\n
\n\n \n Functions
\n \nreprex_to_carbon_download(): downloads the picture \n
\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/set_carbon.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n wrapper for post_tweet to send\ntweets with media created using carbonate.
\n\n \n
\n\n .rtweet(self, private, media, status = self$tweet_status,\n media_format = c(\"png\", \"gif\"), ...)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- media \n
magick-image object or path to image
\n\n\n- status \n
character, status to attach to post, Default: self$tweet_status
\n\n\n- media_format \n
character, type of media to tweet, Default: c('png','gif')
\n\n\n- ... \n
arguments to pass to post_tweet
\n\n
\n
\n Value
\n \n\noutcome from rtweet
\n\n
\n Details
\nIf multiple images are passed they can be either converted to a gif by\nsetting media_format to 'gif' or attached each one to the post.
\n\n
\n\n See also
\n \n\n \n
\n Examples
\nif (FALSE) {\nx <- carbonate::carbon$new()\nx$carbonate(code = readLines(system.file('DESCRIPTION',package='carbonate')))\nx$carbonate(code = 'x+2')\n\n# using default status value (x$tweet_status)\nx$rtweet(system.file('figures/hex_black_small.png',package='carbonate'))\n\nx$rtweet(status = 'these are two pngs',media = x$carbons,media_format='png')\nx$rtweet(status = 'this is a gif', media = x$carbons,media_format='gif')\n\n}\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/tiny.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n function that set the aesthetics of the carbon image output
\n\n \n
\n\n .set_template(self, private, template)\n\n.set_window_control_theme(self, private, theme)\n\n.set_font_family(self, private, family)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- template \n
character, name of template to set $template to
\n\n\n- theme \n
character, theme to set $theme to
\n\n\n- family \n
character, font family to set $font_family to
\n\n
\n
\n\n See also
\n \n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/tinyurl.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n convert carbon uri to tinyurl with option to attach to clipboard.
\n\n \n
\n\n .tiny(self, private, clip = FALSE)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- clip \n
boolean, write tinyurl to clipboard, Default: FALSE
\n\n
\n
\n Value
\n \n\ncharacter
\n\n
\n\n Details
\nIf clip is set to TRUE write_clip will put the\ntinyurl on the clipboard.
\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/reference/uri.html",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n convert uri to tinyurl.
\n\n \n
\n\n tinyurl(uri)\n
\n Arguments
\n- uri \n
character, the uri to convert
\n\n
\n
\n\n Value
\n \n\ncharacter
\n\n
\n\n \n\n \n\n
\n\n \n\n\n \n\n \n\n"
},
{
"path": "docs/sitemap.xml",
"content": "\n\n
\n\n\n \n \n\n
\n \n
\n\n Function that is called in a carbon object to construct valid uri to send to browser
\n\n \n
\n\n .uri(self, private, code)\n
\n Arguments
\n- self \n
carbon self object
\n\n\n- private \n
carbon private object
\n\n\n- code \n
character, script to embbed into the uri
\n\n
\n
\n\n See also
\n \n\n \n
\n Examples
\nif(interactive()){\n\nx <- carbon$new('x <- 1')\n\n# populate from self$code\nx$uri()\n\n# enter manually\nx$uri(code = 'x <- y + 3')\n\n}\n\n
\n\n\n## Unit Tests\n\nUnit Test summary is created using the\n[testthat](https://github.com/r-lib/testthat) package.\n\n| file | n | time | error | failed | skipped | warning | icon |\n|:------------------------------------|----:|------:|------:|-------:|--------:|--------:|:-----|\n| [test-port.R](testthat/test-port.R) | 3 | 0.024 | 0 | 0 | 0 | 0 | |\n| [test-set.R](testthat/test-set.R) | 3 | 0.893 | 0 | 0 | 0 | 0 | |\n| [test-uri.R](testthat/test-uri.R) | 8 | 1.342 | 0 | 0 | 2 | 0 | 🔶 |\n| [test-yml.R](testthat/test-yml.R) | 6 | 2.351 | 0 | 0 | 0 | 0 | |\n\n
\n
\n\nShow Detailed Test Results\n
\n\n| file | context | test | status | n | time | icon |\n|:----------------------------------------|:--------|:-----------------------------------------|:--------|----:|------:|:-----|\n| [test-port.R](testthat/test-port.R#L9) | port | port: init | PASS | 1 | 0.011 | |\n| [test-port.R](testthat/test-port.R#L14) | port | port: reset | PASS | 1 | 0.011 | |\n| [test-port.R](testthat/test-port.R#L19) | port | port: manual | PASS | 1 | 0.002 | |\n| [test-set.R](testthat/test-set.R#L8) | set\\_ | set functions: set_template | PASS | 1 | 0.529 | |\n| [test-set.R](testthat/test-set.R#L13) | set\\_ | set functions: set_font_family | PASS | 1 | 0.363 | |\n| [test-set.R](testthat/test-set.R#L18) | set\\_ | set functions: set_windows_control_theme | PASS | 1 | 0.001 | |\n| [test-uri.R](testthat/test-uri.R#L9) | uri | options: benchmark | PASS | 1 | 0.325 | |\n| [test-uri.R](testthat/test-uri.R#L17) | uri | uri: benchmark | PASS | 1 | 0.235 | |\n| [test-uri.R](testthat/test-uri.R#L21) | uri | uri: 200 | PASS | 1 | 0.528 | |\n| [test-uri.R](testthat/test-uri.R#L27) | uri | encode: encode character | PASS | 1 | 0.002 | |\n| [test-uri.R](testthat/test-uri.R#L31) | uri | encode: no encode character | PASS | 1 | 0.001 | |\n| [test-uri.R](testthat/test-uri.R#L37) | uri | tiny: valid tiny | SKIPPED | 1 | 0.001 | 🔶 |\n| [test-uri.R](testthat/test-uri.R#L43) | uri | tiny: clipboard | SKIPPED | 1 | 0.002 | 🔶 |\n| [test-uri.R](testthat/test-uri.R#) | uri | bad template: error uri | PASS | 1 | 0.248 | |\n| [test-yml.R](testthat/test-yml.R#L24) | yml | yaml fields: rgba | PASS | 1 | 0.525 | |\n| [test-yml.R](testthat/test-yml.R#L29) | yml | yaml fields: template | PASS | 1 | 0.432 | |\n| [test-yml.R](testthat/test-yml.R#L34) | yml | yaml fields: bad font family | PASS | 1 | 0.439 | |\n| [test-yml.R](testthat/test-yml.R#L39) | yml | yaml fields: pv | PASS | 1 | 0.522 | |\n| [test-yml.R](testthat/test-yml.R#L44) | yml | yaml fields: ph | PASS | 1 | 0.431 | |\n| [test-yml.R](testthat/test-yml.R#L59) | yml | namesless palette: fill in palette | PASS | 1 | 0.002 | |\n\n| Failed | Warning | Skipped |\n|:-------|:--------|:--------|\n| 🛑 | ⚠️ | 🔶 |\n\n\n
\n\n"
},
{
"path": "tests/testthat/helpers.R",
"content": "# taken from https://github.com/tidyverse/reprex/blob/master/tests/testthat/helper.R\n\n## used to make clipboard unavailable locally\n# Sys.setenv(\"CLIPBOARD_AVAILABLE\" = TRUE)\n# Sys.setenv(\"CLIPBOARD_AVAILABLE\" = FALSE)\n\nNOT_CRAN <- Sys.getenv(\"NOT_CRAN\", unset = \"\")\n\nON_CRAN <- identical(NOT_CRAN, \"\") || identical(tolower(NOT_CRAN), \"false\")\n\nif (ON_CRAN) {\n Sys.setenv(\"CLIPBOARD_AVAILABLE\" = FALSE)\n}\n\nclipboard_available <- function() {\n\n if (Sys.getenv(\"CLIPBOARD_AVAILABLE\", unset = TRUE)) {\n return(clipr::clipr_available())\n }\n FALSE\n}\n\nskip_if_no_clipboard <- function() {\n if (!clipboard_available()) {\n testthat::skip(\"System clipboard is not available - skipping test.\")\n }\n return(invisible(TRUE))\n}"
},
{
"path": "tests/testthat/test-port.R",
"content": "testthat::context(\"port\")\n\ncarb <- carbonate::carbon$new(code='123')\np <- carb$get_port()\n\ntestthat::describe(\"port\", {\n\n it('init',{\n testthat::expect_true(inherits(carb$get_port(),'integer'))\n })\n \n it('reset',{\n carb$set_port()\n testthat::expect_false(p==carb$get_port()) \n })\n \n it('manual',{\n carb$set_port(1234)\n testthat::expect_equal(carb$get_port(),1234L) \n })\n \n})\n"
},
{
"path": "tests/testthat/test-set.R",
"content": "testthat::context(\"set_\")\n\nx <- carbonate::carbon$new(code = \"abc\", yml = NULL)\n\ntestthat::describe(\"set functions\", {\n it(\"set_template\", {\n x$set_template(x$get_templates()[1])\n testthat::expect_equal(x$template, x$get_templates()[1])\n })\n\n it(\"set_font_family\", {\n x$set_font_family(x$get_font_families()[1])\n testthat::expect_equal(x$font_family, x$get_font_families()[1])\n })\n\n it(\"set_windows_control_theme\", {\n x$set_window_control_theme(x$get_windows_control_themes()[1])\n testthat::expect_equal(x$window_control_theme, x$get_windows_control_themes()[1])\n })\n})\n"
},
{
"path": "tests/testthat/test-uri.R",
"content": "testthat::context(\"uri\")\n\nx <- carbonate::carbon$new(code = \"abc\", yml = NULL)\n\ntestthat::describe(\"options\", {\n bench <- \"bg=rgba(171%2C184%2C195%2C1)&t=seti&wt=none&l=r&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=48px&ph=32px&ln=false&fm=Hack&fs=14px&lh=133%25&si=false&es=1x&wm=false&ts=false&code=abc\"\n\n it(\"benchmark\", {\n testthat::expect_equal(bench, x$options())\n })\n})\n\ntestthat::describe(\"uri\", {\n bench <- \"https://carbon.now.sh/?bg=rgba(171%2C184%2C195%2C1)&t=seti&wt=none&l=r&ds=true&dsyoff=20px&dsblur=68px&wc=true&wa=true&pv=48px&ph=32px&ln=false&fm=Hack&fs=14px&lh=133%25&si=false&es=1x&wm=false&ts=false&code=abc\"\n\n it(\"benchmark\", {\n testthat::expect_equal(bench, x$uri())\n })\n\n it(\"200\", {\n testthat::expect_false(httr::http_error(x$uri()))\n })\n})\n\ntestthat::describe(\"encode\", {\n it(\"encode character\", {\n testthat::expect_equal(\"%2523%2540%2524%2525%27\", x$encode(URL = \"#@$%'\"))\n })\n\n it(\"no encode character\", {\n testthat::expect_equal(\"!();?._~-\", x$encode(URL = \"!();?._~-\"))\n })\n})\n\ntestthat::describe(\"tiny\", {\n it(\"valid tiny\", {\n testthat::skip_on_cran()\n testthat::expect_false(httr::http_error(x$tiny()))\n })\n\n it(\"clipboard\", {\n testthat::skip_on_travis()\n skip_if_no_clipboard()\n \n cl <- x$tiny(clip = TRUE)\n testthat::expect_equal(cl, clipr::read_clip())\n })\n})\n\ntestthat::describe(\"bad template\", {\n x$template <- \"xxx\"\n it(\"error uri\", testthat::expect_error(x$uri(), \"template not valid: xxx\"))\n})\n"
},
{
"path": "tests/testthat/test-yml.R",
"content": "testthat::context(\"yml\")\n\nthis <-\n \"palette:\\n- g: 175.0\\n- a: 0.7\\ntemplate: panda-syntax\\nfont_family: Fira Cod\\npadding_vertical: 11\\npadding_horizontal: 14\"\n\nthis_noname <-\n \"palette:\\n- 175.0\\n- 0.7\\ntemplate: panda-syntax\\nfont_family: Fira Cod\\npadding_vertical: 11\\npadding_horizontal: 14\"\n\nreset <- function(this) {\n tf <- tempfile(fileext = \".yml\")\n cat(this, file = tf, sep = \"\\n\")\n carbonate::carbon$new(code = \"abc\", yml = tf, silent_yml = TRUE)\n}\n\nreset_verbose <- function(this) {\n tf <- tempfile(fileext = \".yml\")\n cat(this, file = tf, sep = \"\\n\")\n carbonate::carbon$new(code = \"abc\", yml = tf, silent_yml = FALSE)\n}\n\ntestthat::describe(\"yaml fields\", {\n it(\"rgba\", {\n x <- reset(this)\n expect_equal(c(r = 171, g = 175, b = 195, a = 0.7), x$palette)\n })\n\n it(\"template\", {\n x <- reset(this)\n expect_equal(\"panda-syntax\", x$template)\n })\n\n it(\"bad font family\", {\n x <- reset(this)\n expect_equal(\"Hack\", x$font_family)\n })\n\n it(\"pv\", {\n x <- reset(this)\n expect_equal(11, x$padding_vertical)\n })\n\n it(\"ph\", {\n x <- reset(this)\n expect_equal(14, x$padding_horizontal)\n })\n})\n\ntestthat::describe(\"yaml verbose\", {\n out <- \"palette:\\n- 171.0\\n- 175.0\\n- 195.0\\n- 0.7\\ntemplate: panda-syntax\\npadding_vertical: 11\\npadding_horizontal: 14\"\n\n x <- testthat::expect_message(object = reset_verbose(this), regexp = \"invalid value\")\n x <- testthat::expect_output(object = reset_verbose(this), regexp = out)\n})\n\ntestthat::describe(\"namesless palette\", {\n x <- reset(this_noname)\n\n it(\"fill in palette\", {\n testthat::expect_equal(x$palette, c(r = 175, g = 0.7, b = 195, a = 1))\n })\n})\n"
},
{
"path": "tests/testthat.R",
"content": "library(testthat)\nlibrary(carbonate)\n\ntest_check(\"carbonate\")\n"
},
{
"path": "vignettes/.gitignore",
"content": "*.html\n*.R\n"
},
{
"path": "vignettes/tests_and_coverage.Rmd",
"content": "---\ntitle: \"Tests and Coverage\"\ndate: \"`r format(Sys.time(), '%d %B, %Y %H:%M:%S')`\"\noutput: rmarkdown::html_vignette\nvignette: >\n %\\VignetteIndexEntry{Tests and Coverage}\n %\\VignetteEngine{knitr::rmarkdown}\n %\\VignetteEncoding{UTF-8}\n---\n \n```{r setup, include = FALSE}\nknitr::opts_chunk$set(\n collapse = TRUE,\n comment = \"#>\",\n eval = FALSE\n)\n```\n\n\n- Coverage\n- Unit Tests\n\nThis output is created by\n[covrpage](https://github.com/yonicd/covrpage).\n\n## Coverage\n\nCoverage summary is created using the\n[covr](https://github.com/r-lib/covr) package.\n\n| Object | Coverage (%) |\n|:----------------------------------------------------|:------------:|\n| carbonate | 51.46 |\n| [R/carbonate.R](https://github.com/yonicd/carbonate/blob/cran_update/R/carbonate.R) | 0.00 |\n| [R/selenium_functions.R](https://github.com/yonicd/carbonate/blob/cran_update/R/selenium_functions.R) | 20.00 |\n| [R/uri_functions.R](https://github.com/yonicd/carbonate/blob/cran_update/R/uri_functions.R) | 38.60 |\n| [R/carbon.R](https://github.com/yonicd/carbonate/blob/cran_update/R/carbon.R) | 60.61 |\n| [R/helpers.R](https://github.com/yonicd/carbonate/blob/cran_update/R/helpers.R) | 76.64 |\n| [R/set_get_functions.R](https://github.com/yonicd/carbonate/blob/cran_update/R/set_get_functions.R) | 100.00 |\n\n\nSession Info\n
\n\n| Field | Value |\n|:---------|:---------------------------------|\n| Version | R version 4.2.1 (2022-06-23) |\n| Platform | x86_64-apple-darwin17.0 (64-bit) |\n| Running | macOS Big Sur 11.6 |\n| Language | en_US |\n| Timezone | America/New_York |\n\n| Package | Version |\n|:---------|:--------|\n| testthat | 3.1.4 |\n| covr | 3.5.1 |\n| covrpage | 0.1 |\n\n\n\n## Unit Tests\n\nUnit Test summary is created using the\n[testthat](https://github.com/r-lib/testthat) package.\n\n| file | n | time | error | failed | skipped | warning | icon |\n|:------------------------------------|----:|------:|------:|-------:|--------:|--------:|:-----|\n| [test-port.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-port.R) | 3 | 0.116 | 0 | 0 | 0 | 0 | |\n| [test-set.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-set.R) | 3 | 0.812 | 0 | 0 | 0 | 0 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R) | 8 | 1.257 | 0 | 0 | 2 | 0 | 🔶 |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R) | 6 | 2.591 | 0 | 0 | 0 | 0 | |\n\n
\n
\n\nShow Detailed Test Results\n
\n\n| file | context | test | status | n | time | icon |\n|:----------------------------------------|:--------|:-----------------------------------------|:--------|----:|------:|:-----|\n| [test-port.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-port.R#L9) | port | port: init | PASS | 1 | 0.105 | |\n| [test-port.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-port.R#L14) | port | port: reset | PASS | 1 | 0.008 | |\n| [test-port.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-port.R#L19) | port | port: manual | PASS | 1 | 0.003 | |\n| [test-set.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-set.R#L8) | set\\_ | set functions: set_template | PASS | 1 | 0.464 | |\n| [test-set.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-set.R#L13) | set\\_ | set functions: set_font_family | PASS | 1 | 0.346 | |\n| [test-set.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-set.R#L18) | set\\_ | set functions: set_windows_control_theme | PASS | 1 | 0.002 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L9) | uri | options: benchmark | PASS | 1 | 0.248 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L17) | uri | uri: benchmark | PASS | 1 | 0.234 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L21) | uri | uri: 200 | PASS | 1 | 0.416 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L27) | uri | encode: encode character | PASS | 1 | 0.002 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L31) | uri | encode: no encode character | PASS | 1 | 0.002 | |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L37) | uri | tiny: valid tiny | SKIPPED | 1 | 0.002 | 🔶 |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#L43) | uri | tiny: clipboard | SKIPPED | 1 | 0.014 | 🔶 |\n| [test-uri.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-uri.R#) | uri | bad template: error uri | PASS | 1 | 0.339 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L24) | yml | yaml fields: rgba | PASS | 1 | 0.515 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L29) | yml | yaml fields: template | PASS | 1 | 0.457 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L34) | yml | yaml fields: bad font family | PASS | 1 | 0.428 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L39) | yml | yaml fields: pv | PASS | 1 | 0.592 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L44) | yml | yaml fields: ph | PASS | 1 | 0.597 | |\n| [test-yml.R](https://github.com/yonicd/carbonate/blob/cran_update/tests/testthat/test-yml.R#L59) | yml | namesless palette: fill in palette | PASS | 1 | 0.002 | |\n\n| Failed | Warning | Skipped |\n|:-------|:--------|:--------|\n| 🛑 | ⚠️ | 🔶 |\n\n\n
\n\n"
}
]