collaborate: Create and edit document collaboratively

In rpruim/collaborate: Utilities for collaborative file editing using Firepad

Description

These objects and functions provide an R interface to Firepad collaborative documents.

Usage

  collaborate(name,
    localdoc = file.path(getwd(), paste0(name, ".Rmd")),
    buffermode = c("Markdown", "r"),
    project = getOption("collaborate")$project,
    group = getOption("collaborate")$group,
    firepad = getOption("collaborate")$firepad)

  ## S3 method for class 'collaborativeDoc'
 edit(name,
    where = c("web", "local"), ...)

  load(object, ...)

  ## Default S3 method:
 load(object, ...)

  ## S3 method for class 'collaborativeDoc'
 load(object, ...)

  source(...)

  ## Default S3 method:
 source(...)

  ## S3 method for class 'collaborativeDoc'
 source(object, local = FALSE,
    ...)

  knit(object, ...)

  ## S3 method for class 'collaborativeDoc'
 knit(object, ...)

  ## S3 method for class 'collaborativeDoc'
 summary(object, ...)

  ## S3 method for class 'collaborativeDoc'
 print(x, ...)

Arguments

name	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. Spaces are not permitted.
localdoc	a character string naming the (path to) a file on your R-system which will be synchronized to the collaborative buffer when using load. By default, this is set to be the same as name. But you can use any document that you're willing to overwrite. To browse for an existing file use file.choose() to select it. Dont' forget the file extension.
group	a character string naming the Firepad group in which the document will be housed.
project	a character string naming the project.
buffermode	a string, either "Markdown" or "r". (This may be extended in the future to include other allowable modes for the CodeMirror editor.)
where	either "web" or "local" indicating which version is to be edited
firepad	a character string specifying the base URL for the firepad server
object	an object
x	and object
local	a logical
...	additional arguments

Examples

options(collaborate = list( firepad="http://www.mosaic-web.org/go", group="mosaic-web", project="CS121") )
myProject <- collaborate(name="example000")
summary(myProject)

rpruim/collaborate documentation built on May 28, 2019, 1:33 a.m.