R.rsp v0.44.0

0

Monthly downloads

0th

Percentile

Dynamic Generation of Scientific Reports

The RSP markup language makes any text-based document come alive. RSP provides a powerful markup for controlling the content and output of LaTeX, HTML, Markdown, AsciiDoc, Sweave and knitr documents (and more), e.g. 'Today's date is <%=Sys.Date()%>'. Contrary to many other literate programming languages, with RSP it is straightforward to loop over mixtures of code and text sections, e.g. in month-by-month summaries. RSP has also several preprocessing directives for incorporating static and dynamic contents of external files (local or online) among other things. Functions rstring() and rcat() make it easy to process RSP strings, rsource() sources an RSP file as it was an R script, while rfile() compiles it (even online) into its final output format, e.g. rfile('report.tex.rsp') generates 'report.pdf' and rfile('report.md.rsp') generates 'report.html'. RSP is ideal for self-contained scientific reports and R package vignettes. It's easy to use - if you know how to write an R script, you'll be up and running within minutes.

Functions in R.rsp

Name Description
.readText Reads the content of a local or an online text file
RspVariableDirective The RspVariableDirective class
RspSourceCode The RspSourceCode class
RspSourceCodeFactory The RspSourceCodeFactory class
RspPage The RspPage class
RspVoid The RspVoid class
buildNonSweaveVignettes Builds all non-Sweave Rnw vignette
FileRspResponse The FileRspResponse class
HtmlRspLanguage The HtmlRspLanguage class
dropEmptyText.RspDocument Drops all empty RSP text constructs
HttpDaemon The HttpDaemon class
RspCutDirective The RspCopyDirective class
buildPkgIndexHtml Builds a package index HTML file
RspCode The RspCode class
RspDirective The abstract RspDirective class
findPandoc Locates the pandoc executable
escape.RspLanguage Escapes a string specifically for a given RSP response language
HttpDaemonRspResponse The HttpDaemonRspResponse class
HttpDaemon$getConfig Retrieves the server's 'config' structure from Tcl
getCompleteCode.RspSourceCodeFactory Gets the source code header, body, and footer
findAsciiDoc Locates the asciidoc executable
getInclude.RspConstruct Checks whether an RSP construct will include text to the output or not
getLanguage.RspLanguage Gets the language string
RspIfDirective The RspIfDirective class
RspCodeChunk The RspCodeChunk class
RspProduct The RspProduct class
buildNonSweaveTexToPdf Compiles all TeX files into PDFs
RspIncludeDirective The RspIncludeDirective class
RspLanguage The RspLanguage class
RspUnknownDirective The RspUnknownDirective class
RspText The RspText class
RspRSourceCode The RspRSourceCode class
getParameters.HttpRequest Gets all parameters
getRemoteHost.HttpRequest Gets the fully qualified name of the client that sent the request
getPath.FileRspResponse Gets the path of the directory of the current RSP file
RspShSourceCode The RspShSourceCode class
buildNonSweaveVignette Builds a non-Sweave Rnw vignette
RspMetaDirective The RspMetaDirective class
compileLaTeX Compiles a LaTeX file
compileKnitr Compiles a Knitr file
evaluate.RspString Parses, translates, and evaluates the RSP string
RspShSourceCodeFactory The RspShSourceCodeFactory class
HttpDaemon$getRootPaths Gets the root directories of the HTTP daemon
getType.RspPageDirective Gets the content type
getType.RspDocument Gets the type of the RspDocument
getEcho.RspCode Checks whether the source code should be echoed or not
HttpDaemon$isStarted Checks if the HTTP daemon is started
exprToCode.RspSourceCodeFactory Translates an RspExpression into source code
getComment.RspComment Gets the comment
makeSourceCode.RspSourceCodeFactory Makes a RspSourceCode object
getCode.RspCode Gets the source code
getFile.RspEvalDirective Gets the file attribute
print.RspObject Prints a summary of an RSP object
as.character.RspStringProduct Returns a plain character string representation of an RSP string product
getServerName.HttpRequest Gets the host name of the server that reviewed the request
getParameter.HttpRequest Gets a parameter
process.RspProduct Processes an RSP file product
getScheme.HttpRequest Gets the scheme used to make this request
as.character.HttpRequest Returns a short string describing the HTTP request
getOutput.FileRspResponse Gets the output for an RSP response
asRspString.RspConstruct Recreates an RSP string from an RspConstruct
parseCode.RspRSourceCode Parses the R code
parseDocument.RspString Parses an RSP string into a RSP document
parseDocument.RspParser Parse an RSP string into and RSP document
HttpRequest The HttpRequest class
rfile Evaluates and postprocesses an RSP document and outputs the final RSP document file
getWrap.RspIncludeDirective Get the wrap length
rspTangle A tangle function for RSP documents
startHelp.HttpDaemon Starts the HTTP daemon and launches the help page
hasParameter.HttpRequest Checks if a parameter exists
browseRsp Starts the internal web browser and opens the URL in the default web browser
compileSweave Compiles a Sweave file
parseDirective.RspUnparsedDirective Parses the unknown RSP directive for its class
compileRsp Compiles an RSP file
flush.RspResponse Flushes the response buffer
rcompile Compiles an RSP document
rcode Compiles an RSP document and returns the generated source code script
Non-documented objects Non-documented objects
view.RspProduct Views the RSP product
splitUrl Decomposes a URL into its components
writeResponse.HttpDaemon Writes a string to the HTTP output connection
HttpDaemon$start Starts the HTTP daemon
getAbsolutePath.FileRspResponse Gets the absolute pathname to the current RSP file
R.rsp-package Package R.rsp
RspEvalDirective The RspEvalDirective class
RRspPackage The RRspPackage class
RspException The RspException class
subset.RspDocument Subsets an RspDocument
RspExpression The RspExpression class
RspFileProduct The RspFileProduct class
toLatex.character Escapes character strings to become LaTeX compatible
getAbsolutePath.RspPage Gets the absolute pathname to the current RSP file
RspComment The RspComment class
RspString The RspString class
getContentType.HttpRequest Gets the MIME type of the body of the request
RspStringProduct The RspStringProduct class
getAttributes.default Gets and sets attributes of an object
RspParser The RspParser class
RspUnparsedDirective The RspUnparsedDirective class
RspUnparsedExpression The RspUnparsedExpression class
RspConstruct The RspConstruct class
RspPageDirective The RspPageDirective class
RspRSourceCodeFactory The RspRSourceCodeFactory class
findProcessor.RspProduct Locates a processor for an RSP product
HttpDaemon$appendRootPaths Appends and inserts new paths to the list of known root directories
compileAsciiDoc Compiles an AsciiDoc file
compileAsciiDocNoweb Compiles an AsciiDoc noweb file
compileMarkdown Compiles a Markdown file
RspResponse The RspResponse class
compileRnw Compiles a Rnw file
HttpDaemon$getDefaultFilenamePattern Gets the default filename pattern to be loaded by the HTTP daemon
as.character.HttpDaemon Returns a short string describing the HTTP daemon
flatten.RspDocument Flattens an RspDocument
evaluate.RspRSourceCode Parses and evaluates the R code
buildVignette Builds a vignette
RRspPackage$capabilitiesOf Checks which tools are supported
evaluate.RspSourceCode Evaluates the source code
getContent.RspIncludeDirective Gets the content of the RSP include directive
HttpDaemon$getPort Gets the socket port of the HTTP daemon
getPath.RspDocument Gets the path to the source reference of an RSP string
getFile.RspIncludeDirective Gets the file attribute
getPath.RspPage Gets the path of the directory of the current RSP file
evaluate.RspShSourceCode Evaluates the shell (sh) code
evaluate.RspDocument Parses, translates, and evaluates the RSP document
getContent.RspEvalDirective Gets the content of the RSP eval directive
getComment.RspConstruct Gets the comment of an RSP construct
getSource.RspString Gets the source reference of an RSP string
mergeTexts.RspDocument Merge neighboring 'text' elements
getComment.RspLanguage Gets a comment string specific for a given RSP response language
getProtocol.HttpRequest Gets the name and version of the protocol used to make this request
nbrOfLines.RspString Gets the number of lines in an RSP string
HttpDaemon$getHttpRequest Gets the HTTP request
parseVignettes Locates and parses all vignettes
getSuffixSpecs.RspConstruct Gets the suffix specifications
parseVignette Parses an Rnw file
rstring Evaluates an RSP string and returns the generated string
getRealPath.HttpRequest Gets the file system path for a given URI
getRemoteAddress.HttpRequest Gets the IP address of the client that sent the request
trimNonText.RspDocument Trims all non-text RSP constructs
requireAttributes.RspDirective Asserts that certain attributes exist
rspWeave A weave function for RSP documents
getNewline.RspLanguage Gets the newline string specific for a given RSP response language
getContentLength.HttpRequest Gets the length of contents
getName.RspPage Gets the (base)name of the current RSP file
HttpDaemon$restart Restarts the HTTP daemon
getVerbatim.RspIncludeDirective Checks if verbatim include should be used or not
getContent.RspText Gets the contents of the RSP text
getName.FileRspResponse Gets the (base)name of the current RSP file
typeOfRnw Checks whether an Rnw file is a Sweave or a knitr file
getLanguage.RspSourceCodeFactory Gets the language
getServerPort.HttpRequest Gets the port number on which this request was received
getType.RspProduct Gets the type of an RSP product
getSource.RspDocument Gets the source reference of an RSP document
getType.RspString Gets the type of an RSP string
nbrOfParameters.HttpRequest Gets the number of parameters
openUrl.HttpDaemon Starts the HTTP daemon and launches the specified URL
parseExpression.RspUnparsedExpression Parses the unknown RSP expression for its class
parseRaw.RspParser Parses the string into blocks of text and RSP
getVerbatim.RspLanguage Gets a verbatim string specific for a given RSP response language
preprocess.RspDocument Processes all RSP preprocessing directives
hasProcessor.RspProduct Checks whether a processor exist or not for an RSP product
rcat Evaluates an RSP string and outputs the generated string
print.RspArguments Prints RSP arguments
indexOfNonQuoted Gets the first index of a string that is not inside a double quoted string
HttpDaemon$processRsp Processes an RSP page
HttpDaemon$setRootPaths Sets a new set of root directories for the HTTP daemon
toSourceCode.RspSourceCodeFactory Translates an RSP document to source code
HttpDaemon$terminate Terminates the HTTP daemon
trim.RspDocument Trims each of the RSP constructs
toR.RspDocument Translates the RSP document into R source code
toR.RspString Parses and translates the RSP string into R code
rclean Compiles an RSP document into a preprocessed and validated RSP document
tangle.RspSourceCode Drops all text-outputting calls from the source code
writeResponse.RspResponse Writes an RSP response to the predefined output
rargs Gets RSP arguments of an RSP document
HttpDaemon$sourceTcl Loads the Tcl source for the HTTP daemon into R
[.RspDocument Subsets an RspDocument
RspDocument The RspDocument class
RspObject The abstract RspObject class
RspErrorDirective The RspErrorDirective class
tidy.RspSourceCode Tidy up the RSP source code
No Results!

Vignettes of R.rsp

Name
incl/example.txt.rsp
Dynamic_document_creation_using_RSP.tex.rsp
RSP_intro.html.rsp
RSP_refcard.tex.rsp
R_packages-LaTeX_vignettes.ltx
R_packages-RSP_vignettes.md.rsp
R_packages-Static_PDF_and_HTML_vignettes.pdf.asis
R_packages-Vignettes_prior_to_R300.tex.rsp
No Results!

Last month downloads

Details

SuggestsNote Recommended: R.devices, base64enc, markdown
VignetteBuilder R.rsp
License LGPL (>= 2.1)
URL https://github.com/HenrikBengtsson/R.rsp
BugReports https://github.com/HenrikBengtsson/R.rsp/issues
LazyLoad TRUE
NeedsCompilation no
Packaged 2020-07-09 15:45:49 UTC; hb
Repository CRAN
Date/Publication 2020-07-09 16:20:02 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/R.rsp)](http://www.rdocumentation.org/packages/R.rsp)