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

Last month downloads

Details

SuggestsNote Recommended: digest, R.devices, base64enc, markdown
VignetteBuilder R.rsp
Date 2016-12-05
License LGPL (>= 2.1)
URL https://github.com/HenrikBengtsson/R.rsp
BugReports https://github.com/HenrikBengtsson/R.rsp/issues
LazyLoad TRUE
NeedsCompilation no
Packaged 2016-12-05 23:35:12 UTC; hb
Repository CRAN
Date/Publication 2016-12-06 07:52:32

Include our badge in your README

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