gadenbuie
commented
2 years ago Naming is hard! I like the build, render, print root words, but they're also quite loaded with many definitions in the R world. For example, there's a lot of variety in the buildr packages.
Of the three, I like render since it's the best match for the action — xaringanBuilder basically provides variations on rmarkdown::render() — and it's also the verb Quarto uses — quarto render.
But I'm hesitant to use the bare verb since it could make it harder to find. I also know I would feel pressured by the package name render to do too much: render all the things or all the formats, etc. But with something with a small modification, it's a little easier to say no to some things.
Here's a quick brain dump of ideas:
rendermyrendermerenderitrenderarendrele(render the in French)rendertherenderizar(Portuguese)renderizerrenderify
Btw, have you seen pak::pkg_name_check()? Very helpful here!
> pak::pkg_name_check("renderizar")
╔══════════════════════════════════════════════════════════════════════════════╗
║ –*– renderizar –*– ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│ ✔ valid name ✔ CRAN ✔ Bioconductor ✔ not a profanity │
└──────────────────────────────────────────────────────────────────────────────┘
┌ Wikipedia ───────────────────────────────────────────────────────────────────┐
│ Renderizar No definition found │
└──────────────────────────────────────────────────────────────────────────── ┘
┌ Wiktionary ──────────────────────────────────────────────────────────────────┐
│ renderizar No English definition found │
└─────────────────────────────────── https://en.wiktionary.org/wiki/renderizar ┘
┌ Acroynms (from Acromine) ────────────────────────────────────────────────────┐
│ No acronyms found. │
└──────────────────────────────────────────────────────────────────────────────┘
┌──────────────────────────────────────────────────────────────────────────────┐
│ Sentiment: 😐 (0) │
└──────────────────────────────────────────────────────────────────────────────┘
jhelvy
I'm starting to tinker with quarto revealjs presentations, and they're pretty slick. It also got me thinking more about what
{xaringanBuilder}actually does, and I'm realizing that it can be used for much more than just xaringan presentations. Other than the few xaringan-specific functions where it takes the .Rmd file as the input (e.g.,build_social()), all the other functionality works for revealjs presentations. I also use it all the time to convert pdfs into png files to share individual slides or to make a thumbnail for a video, etc.With this in mind, I was thinking perhaps we should consider re-naming it, or just start a new package based on
{xaringanBuilder}that has a broader purpose? Something that users of xaringan, revealjs, etc. could all use to renders their presentations (and other media) to different formats?I was checking names, and both
{buildr}and{printr}already exist on CRAN. But{build}and{render}are both available. I was thinking of simplifying the function names to just be the output type, so if you changed the package name it'd look something like this in use:build::pdf(),build::png(),build::html()render::pdf(),render::png(),render::html()My preference is for a verb package name, like
{build}since it has the same feel of the current functions (e.g.,build::pdf()instead ofxaringanBuilder::build_pdf()). It's also so much easier to type...{xaringanBuilder}is kind of an annoyingly long name.Thoughts?