collaborate: Simultaneous Collaborate Editing

In dtkaplan/NIMBIOS: Data and editing support for the Teaching with R tutorial

Description

Support for collaborative editing in Rmd and R formats

Usage

collaborate(group = "mosaic-web", project = "CS121", doc,
  localdoc = paste(doc, "Rmd", sep = "."), buffermode = c("Markdown", "r"))

Arguments

doc	A character string naming the document in the collaborative editor. It's best if this is simple and memorable, so you can communicate it to your collaborators. Don't use spaces.
localdoc	A character string naming the file on your R-system which will be synchronized to the collaborative buffer when you give the "capture" argument. By default, this is set to be the same as doc. But you can use any document that you're willing to overwrite. If it's to be a new document, give the name (including relative path) of that document as localdoc. If it's an existing document, you can give the name or use file.choose() to select it. REMEMBER the file extension.
group	A character string naming the Firepad group in which the document will be housed. By default, this is "mosaic-web", which was set up for experimental testing. IT SHOULD BE TURNED INTO AN OPTION setting.
project	A character string naming the project. By default, for COMP-121 it's set to "CS121". THIS SHOULD BE TURNED INTO AN OPTION.
buffermode	A string, either "Markdown" or "r" or some other allowable mode for the CodeMirror editor.

Details

Support for Simultaneous Collaborative Editing

Value

A function that can be called with arguments "edit" to bring up the collaborative browser editor, "knit" to run an Rmd document through knitr/markdown, "source" to source the file into the global environment, "capture" to save the collaborative buffer to the local file (given by the argument localdoc), or "info" to give various information about the buffer.

dtkaplan/NIMBIOS documentation built on May 15, 2019, 4:58 p.m.