R.rsp v0.43.2

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

Include our badge in your README

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