mkyarr: Create a ReDoc Style 'yarr' Compendium
In BioStatMatt/yarr: Extensible Framework for R Reporting

Description Usage Arguments Details Value Author(s) Examples

View source: R/mkyarr.R

The mkyarr function creates a directory structure for ReDoc style compendia that use yarr for mixing R output with text, or markup (i.e., ReStructuredText or HTML).

mkyarr(project,
       remote_host="data.vanderbilt.edu",
       remote_user="shotwems",
       remote_path=paste0("/home/ssl/collab/shotwems/",
                          project, "/"),
       remote_url =paste0("https://", remote_host,
                          "/collab/shotwems/",
                          project, "/"),
       verbose=FALSE)

`project`	A character string, the project (and main directory) name
`remote_host`	A character string, address of remote server where HTML files will be hosted
`remote_user`	A character string, remote server user name
`remote_path`	A character string, remote server path for hosted HTML files
`remote_url`	A character string, remote server URL for hosted HTML files
`verbose`	A logical, whether `mkyarr` should be verbose about the files created

The mkyarr function creates a directory structure and template files for projects that utilize a ReDoc (reproducible document) framework. The ReDoc framework uses the Linux utility make to implement build, clean, view, and burn procedures for a reproducible document. The build procedure inputs source documents and renders an output document (an RST/HTML file in this case). The clean procedure removes ancillary files created during the build process. The view procedure opens the output documents for viewing using the appropriate software (i.e., a web browser). And, the burn procedure removes (deletes) output documents. These four procedures implement the classical ReDoc framework. An additional procedure publish is implemented here in order to publish HTML files to a remote web server. The mkyarr function creates a Makefile with each of these five targets. The remote_* arguments to mkyarr supply details related to the publish target. These details and others (e.g., the external programs used to synchronize files with the remote server, and to view web pages) may be modified by editing the resulting Makefile.

The mkyarr function creates the following directories and files:

<project>/main project directory
<project>/MakefileReDoc Makefile
<project>/yarr/yarr subdirectory
<project>/yarr/index.rst.Rtemplate RST yarr file
<project>/html/html subdirectory
<project>/html/cache/html/cache subdirectory
<project>/html/style.cssHTML CSS style file
<project>/data/data subdirectory
<project>/data/cache/data/cache subdirectory
<project>/docs/docs subdirectory
<project>/R/R subdirectory
<project>/R/common.Rcommon R functions

None

Matt Shotwell <Matt.Shotwell@Vanderbilt.edu>

    ## Not run: 
        mkyarr("example")
        # from terminal
        # $ cd example
        # $ make build
        # $ make view
    
## End(Not run)