Package: rmdtools 0.2.7

rmdtools: Tools for RMarkdown

Tools for RMarkdown

Authors:Sebastian Kranz

rmdtools_0.2.7.tar.gz
rmdtools_0.2.7.zip(r-4.7)rmdtools_0.2.7.zip(r-4.6)rmdtools_0.2.7.zip(r-4.5)
rmdtools_0.2.7.tgz(r-4.6-any)rmdtools_0.2.7.tgz(r-4.5-any)
rmdtools_0.2.7.tar.gz(r-4.7-any)rmdtools_0.2.7.tar.gz(r-4.6-any)
rmdtools_0.2.7.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
rmdtools/json (API)

# Install 'rmdtools' in R:
install.packages('rmdtools', repos = c('https://skranz.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/skranz/rmdtools/issues

On CRAN:

Conda:

2.08 score 2 stars 2 packages 6 scripts 147 exports 32 dependencies

Last updated from:399fa7001c (on master). Checks:7 WARNING, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64WARNING131
source / vignettesOK177
linux-release-x86_64WARNING115
macos-release-arm64WARNING96
macos-oldrel-arm64WARNING113
windows-develWARNING75
windows-releaseWARNING74
windows-oldrelWARNING82
wasm-releaseOK110

Exports:adapt.hf.blocksadapt.if.blocksadd.code.uiargs.to.chunk.headerarrange_.NULLarrange.NULLcat.rmd.paramscat.whisker.paramschunk.opt.string.to.listcompile.note.block.to.htmlcompile.note.block.to.tagcompile.rmdcopy.non.null.fieldscorrect.hf.htmldefault.block.infoeval.chunk.like.whiskereval.chunks.in.texteval.hfeval.note.blockeval.placeholdereval.placeholderseval.rmd.blocks.in.texteval.vectorized.if.dfeval.whiskers.in.textexample.compile.note.blocks.to.htmlexample.random.string.collusion.probexample.rmd.blocks.to.placeholdersexample.rmdvectorexamples.compile.rmdexamples.fast_dfexamples.find.rmd.blocksexamples.get.whisker.with.typeexamples.nestedexamples.read.yamlexamples.replace.mathjax.dollarsexamples.transformTagDependeciesfast_dffilter_.NULLfilter.NULLfind.dot.blocksfind.placeholdersfind.rmd.blocksfind.rmd.chunksfind.rmd.nestedfirst.non.nullfirst.none.nullformat.data.frameformat.valsget.block.specget.block.types.dfget.blocks.txtget.default.block.specget.levels.parentsget.levels.parents.by.typesget.note.block.specget.start.end.levelsget.types.indsget.whiskers.with.typehideShowButtonhtml.tablehtml.templateimport.yamlinline.dependenciesinline.dependencyinternal.remove.verbatim.end.chunksis.trueknit.chunkknit.rmdknit.rmd.in.tempmake.block.infomake.chunk.infomake.if.block.infomake.note.block.infomake.placeholder.infomake.whisker.infomakeDependenciesRelativeToPackagemakeDependencyRelativeToPackagemark_utf8markdown.blocks.call.listmatch.blocks.start.endmathjax.dollars.to.bracketsmathjaxHeadermd2htmlmutate_mutate_.NULLmutate.NULLnlistnormalize.idopen.chunk.deviceparse.arg.strparse.block.argsparse.chunk.argsparse.chunk.namesparse.hashdot.yamlpaste.whiskersprint.yamlrandom.stringrandom.string.collusion.probread.as.utf8read.yamlreadUtf8remove.quotesremove.rmd.chunksrender.compiled.rmdrender.deps.as.singletons.tagsrender.rmd.in.temprender.valuerender.vectorized.compiled.rmdreplace.blocks.txtreplace.if.blocksreplace.if.blocks.from.if.dfreplace.mathjax.dollarsreplace.whisker.with.blocksreplace.whiskersreverse.whisker.placeholdersrmd.between.start.end.linesrmd.blocks.to.placeholdersrmd.chunks.to.placeholdersrmd.whiskers.to.placeholdersscsculpt.chunksculpt.evalsculpt.outputselect_.NULLselect.NULLset.rmd.placeholderssignif.or.roundsimple.html.pagesplit.by.line.startsplit.text.in.startline.blockstable.knit_print.data.frametransformTagDependenciesunmatched.blocks.diagnosticsview.htmlview.rmdwhisker_printwhisker_print.defaultwhisker.print.numericwhiskered.html.to.listwhiskered.txt.to.listwhiskers.call.listwhiskers.str.blocks.poswith.mathjaxwithMathJaxNoHeaderwriteUtf8yaml.bool.handler.noyaml.bool.handler.yes

Dependencies:base64encclicodeUtilscommonmarkdigestdplyrevaluatefastmapgenericsgluehighrhtmltoolsknitrlifecyclelitedownmagrittrmarkdownpillarpkgconfigR6restorepointrlangstringistringrstringtoolstibbletidyselectutf8vctrswithrxfunyaml

Readme and manuals

Help Manual

Help pageTopics
Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluationadapt.hf.blocks
Adapt header and footer of if blocks for output format and parse already the if condition for faster runtime evaluationadapt.if.blocks
Add code button with div to an uiadd.code.ui
Create a Rmd chunk header line from a list of argumentsargs.to.chunk.header
Scan all used block and whisker parameters in an .rmd file and create a template for a listcat.rmd.params
cat.whisker paramscat.whisker.params
Translates a chunk header to a list of its optionchunk.opt.string.to.list
Main function to compile rmd to htmlcompile.rmd
Render a knitr chunk in the same way as a whisker (taking into some chunk options, like results="asis")eval.chunk.like.whisker
Render all knitr chunks in the same way as a whisker (taking into some chunk options, like results="asis")eval.chunks.in.text
Evaluate a placeholder and return its valueeval.placeholder
Evaluate placeholders in compiled rmdeval.placeholders
compile all given types of rmd blockseval.rmd.blocks.in.text
evaluate whiskers and replace them in the texteval.whiskers.in.text
Create a data_frame (tibble) considerably fasterfast_df
Find blocks that have only a starting line of the formfind.dot.blocks
Find all rmd blocks that start with a line `#< ...` and end with a line `#>`find.rmd.blocks
Find the start and end lines of all rmd chunksfind.rmd.chunks
find blocks, chunks and dot blocks and add nesting infofind.rmd.nested
Find the parent index of each row given a vector levels that describes the nestednessget.levels.parents
Find the parent index of each row given a vector levels that describes the nestednessget.levels.parents.by.types
Find the levels given ordered start and end positions of possible nested blocksget.start.end.levels
Gets for each element the index of its typeget.types.inds
A button that toogles whether content in a div is displayed or nothideShowButton
own function to print a compact html table from a data frame with option to select rowhtml.table
Variant of htmltools::htmlTemplatehtml.template
A more convenient yaml importerimport.yaml
Inline dependencies with local file referencesinline.dependencies
Inline a dependency with local file referencesinline.dependency
Knits a single rmd knitr chunk Has several options. The output can be given as html, shiny tag or markdown eval_mode = "sculpt" shows shows the final output ommiting all intermediate results and messages deps.action ="add" adds back dependecies to html or shiny tag. Important for rendering shiny widgets deps.action ="relative" also changes absolute dependencies to relative dependencies based on a package. That is important if we want to save the generated shiny tag and use it as part of a shiny application on another computer.knit.chunk
Knits the rmd txtknit.rmd
Knits the rmd txt inside a temporary directory instead of the current wdknit.rmd.in.temp
Parse a n rmd chunk and store info in a listmake.chunk.info
Make a info for a placeholder objectmake.placeholder.info
Parse a whisker and create meta infomake.whisker.info
Change in a lst of dependencies absolute paths in scr$file to a relative path based on a packagemakeDependenciesRelativeToPackage
Change in an dependency an absolute path in scr$file to a relative path based on a packagemakeDependencyRelativeToPackage
Recursively encode strings in list as UTF-8mark_utf8
Own markdown to html converter that interfaces commonmarkmd2html
Normalize an id to letters that are allowednormalize.id
Parse an arg.str as listparse.arg.str
Parse the name of an rmd blockparse.block.args
Parse the name of a knitr chunk and its argumentsparse.chunk.args
Take a vector of chunk header lines and returns the chunk namesparse.chunk.names
Parse a hashdot yaml stringparse.hashdot.yaml
Subtitutes whiskers and pastes string parts togetherpaste.whiskers
Prints list read from a yaml fileprint.yaml
Create n random strings of length nchar eachrandom.string
Read a text file and convert to UTF-8read.as.utf8
Reads a yaml file and returns as a listread.yaml
Read a text file that was saved in UTF-8 formatreadUtf8
Remove quotes from stringsremove.quotes
Removes the rmd chunks with the given chunk names from rmd coderemove.rmd.chunks
Render a compiled rmdrender.compiled.rmd
Render a list of dependencies as a list of singleton head tags TO DO: Some dependencies may use local file names... Those dependencies must be fully inlined...render.deps.as.singletons.tags
Render with RMarkdown::render the rmd txt inside a temporary directory instead of the current wdrender.rmd.in.temp
Render a value in a format specified by out.typerender.value
extract #< if blocks from a rmd txtreplace.if.blocks
replace whiskers using a list of values, with several optionsreplace.whiskers
Reverses whisker placeholders by their original whiskersreverse.whisker.placeholders
Extract rmd txt between start.line and end.line tagrmd.between.start.end.lines
Replace blocks with placeholderss of the form idrmd.blocks.to.placeholders
Replace chunks with placeholderss of the form idrmd.chunks.to.placeholders
Replace whiskers with placeholders of the form idrmd.whiskers.to.placeholders
Like paste0 but returns an empty vector if some string is emptysc
A simple html pagesimple.html.page
Splits a text vector into different blocks by a start line tokensplit.by.line.start
knitr data.frame printer as nice HTML table with several optionstable.knit_print.data.frame
Tag a shiny tag or a list of tags, and transform all dependencies with the function transform.fun which takes a list of dependecies as argumenttransformTagDependencies
View an extended rmd fileview.html
View an extended rmd fileview.rmd
Print a whisker objectwhisker_print
Need to implement different methodswhisker_print.default
Write text file in UTF-8 formatwriteUtf8