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

Last month downloads

Details

SuggestsNote Recommended: digest, R.devices, base64enc, markdown
VignetteBuilder R.rsp
Date 2015-12-18
License LGPL (>= 2.1)
URL https://github.com/HenrikBengtsson/R.rsp
BugReports https://github.com/HenrikBengtsson/R.rsp/issues
LazyLoad TRUE
NeedsCompilation no
Packaged 2015-12-19 01:49:25 UTC; hb
Repository CRAN
Date/Publication 2015-12-19 11:01:53

Include our badge in your README

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