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

Include our badge in your README

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