pushWiki: Push a source file to a Working Wiki

In bbolker/wwiki: Working Wiki interaction

Description

Push a source file to a Working Wiki

Usage

  pushWiki(file, page, project = page, display = NULL,
    filename = basename(file), readFile = TRUE,
    wiki = "bio_708_2013",
    wikibase = "http://lalashan.mcmaster.ca/theobio/",
    autodepends = TRUE, autoopen = autodepends,
    autoRsave = TRUE, imagefile = NULL, verbose = FALSE,
    ...)

Arguments

file	path to file for upload
page	wiki page to which to push the file(s).
project	wiki project to use (default is the same as the page)
display	(character) display tag for the file on WW: e.g. "myfile.html" if you want an HTML version of your file to be displayed. Other typical choisces are "source", "none", "link". [FIXME: WW reference on display options?]
filename	Name of file to assign on WW
readFile	(logical) extract text to upload from a file?
wiki	WW name: either relative to wikibase, or a full URL
wikibase	base URL for WW
autodepends	(logical) automatically detect and upload dependencies?
autoopen	(logical) automatically open modified page in a web browser?
autoRsave	(logical) add a save.image() command to the end of R markdown, Sweave, and R files?
imagefile	(logical) post file to the project file space by prepending "Image:project$" to the page name? (Default is to post data files – RData, rda, csv, txt, dat, tab to the project file space.)
verbose	verbose output?
...	additional arguments (esp. username) to pass to loginWiki

Details

• In general a user name and password are required. If not specified, the user name will be retrieved via getOption("MWUser") [for "MediaWiki user"] if possible; see example below for setting the option. Cookies will be saved (at present via options so that passwords need be entered only once per R session. (If saving unencrypted cookies in memory is a concern, please don't use this package.)

• Pushing the same file twice will overwrite the original version.

• If autodepends is TRUE, the function will try to detect dependencies (data files etc.) in the code and upload them automatically to the same page. This will only work in simple cases (filename must not be specified explicitly; all files must be in the working directory; each load command must be specified on a separate line; etc.). The autodepends options currently detects read.table, read.csv, load, and source.

• If display is not explicitly set, the function will try to guess an appropriate default. The current behavior is to display R Markdown and markdown (rmd, md) as HTML, LaTeX and Sweave (tex, Rnw) as PDF; R and HTML files as source; and everything else as links.

Value

vector of name(s) of uploaded file(s)

Examples

## Not run: 
pushWiki("pulse.rmd",user="Bb",page="pushTest")
## set persistent user name (works until you start a new R session;
## you could set it in your \code{\link{Rprofile}})
options(MWUser="Bb")
## now username is unnecessary
pushWiki("pulse.rmd",
          page="pushTest")

## End(Not run)

bbolker/wwiki documentation built on May 11, 2019, 9:30 p.m.