Skip to content

Wrapper functions for googledrive 📦 with conversions to allow collaborative RMD editing

Notifications You must be signed in to change notification settings

benmarwick/rmdrive

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

rmdrive

rmdrive provides easy functions to move rmd files to googledrive for synchronous collaboration, then return it back to a local .Rmd for knitting.

Installation

This package is not on CRAN. To use this package please run the following code:

devtools::install_github("ekothe/rmdrive")
library(rmdrive)

How to use

A typical workflow where this package is useful is when:

  • you have a google doc that you or someone else has started
  • you want to turn it into an R Markdown file so you can write R code in there, or simply work on it in your preferred editor
  • you want to keep the R Markdown file in sync with the Google doc while you and others work on them together

Let’s assume there is an existing google doc that you want to bring to your desktop as an R Markdown file. This function will firstly prompt you to authenticate, and then it will download the google doc into your current working directory as an Rmd file:

download_rmd(file = "my-r-markdown-file-name",  # do not include the .Rmd 
             gfile = "My google doc filename")  # name of google doc file

Now let’s imagine you do some work on your Rmd, write some code, etc. At some point you’ll be ready to update the Google doc so your non-R-using co-authors can see what you’ve done. This line of code will update the existing Google doc with the changes you made to the Rmd file:

update_rmd(file = "my-r-markdown-file-name",    # do not include the .Rmd 
           gfile = "My google doc filename")  # name of google doc file

You can run that line often while editing, similar to git commit (it does take about 5-10 seconds to complete the update). Imagine now that some time passes and your co-author has updated the Google doc while you’ve been doing other things, and you want to update your local Rmd with their changes.

Note that code blocks are not decorated like we see them in RStudio or knitted output. Plus the code is not run as it moves from Rmd to Google doc, so you will not see any output from the code in your Google doc.

About

Wrapper functions for googledrive 📦 with conversions to allow collaborative RMD editing

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • R 100.0%