ropensci-archive / gdoc

:no_entry: ARCHIVED :no_entry: An R Markdown Template for Google Docs

gdoc

This repository has been archived. The former README is now in README-NOT.md.

gdoc's Issues

Round trips: Rmd --> Google Doc --> Rmd

Of course this would be fantastic. For the moment, however, we are focusing on the one way trip: Rmd ➡️ Google Doc. It is not clear how to un-knit a document and is not specific to Google Docs.

A few links I'm collecting relevant to round tripping and authoring Google Docs natively (vs via Word docx conversion on Google Drive):

• Converting document formats with Pandoc. Iintermediate JSON based abstract syntax tree (AST) representation of the document. Manipulating the AST.
• Structure of a document. "A Google Doc is structured much like an HTML document".
• gdoc Structure Viewer, gdoc2json on GitHub (via @dani-lbnl).

Google Apps Script usage

We are currently including the scope needed to use Google Apps Script, which we used experimentally to attach the source Rmd to the gdoc after upload. But we are not actually doing this at the moment. We should probably remove that scope and just restore it if/when we use Google Apps Script again.

Token refresh

Figure out why current tokens contain only access token and no refresh token. Fix that.

To be archived

@noamross should this repo be archived? In that case

• before archiving maybe remove the installation instructions from the README? I'm always worried someone could miss the archived signs and install.

• It'd also be good to add links to related active projects if relevant.

• Close all issues

Testing using base 64 encoded token

So in an attempt to be clever, I tried encoding a .httr-oauth token as a base64 string and saving it as an environmental variable in Travis. To test whether this would work at all, I wrote a few short tests to check that the variable is there, non-zero, and that I can create the token from it (https://github.com/ropenscilabs/gdoc/blob/master/tests/testthat/test-base64token.R).

Tests pass locally with both devtools::test() and R CMD check when the base64 token is in .Renviron. On Travis the 3rd test, in which I write the variable to a file and check that it exists, does not pass: https://travis-ci.org/ropenscilabs/gdoc/jobs/120776471#L574 . This likely has something to do with the local file paths or permissions, but I've yet to figure it out.

Using with Shiny Server (non-interactive)

I have really enjoyed testing this library and would like to use it to enable google docs output for a program I am writing that has educators as an intended audience, since they are often on Google Apps systems. As written, however, it appears to be incompatible with Shiny Server and the online RStudio server - I think this is because of the way auth is done. Is that right? Do you think it would be possible to use something like the googleAuthR package to make this library work on Shiny and RStudio servers?

I'm happy to play around with this possibility if you think I'm correct that it might solve the problem.

Google Apps Script link

@nicolewhite Could you add a link here to the script? And/or just drop the source in? I'd like to be able to turn that feature on again or extend it. Basically, before it gets lost in the sands of time, can you do a brain dump on what you learned about this?

Open the gdoc in the browser

Create a function that makes this easier in the rmarkdown::render() case, i.e. something better than copying the link left as a message in the R Markdown log pane.

Update existing gdoc, as opposed to creating de novo each time

Sort out the 500 errors thrown by doc_update() so we can restore this feature.

Google Docs "Suggestions"

This might be really effing close to a pull request ..... which is very intriguing.

https://support.google.com/docs/answer/6033474?hl=en

https://www.youtube.com/watch?v=vytBjbfv9Qw

Proper document template

Pretty sure @noamross had this set up (or this is what he was thinking and heading towards) and I dismantled / broke it. Oops. Then gtemplate() can be deleted, right?

http://rmarkdown.rstudio.com/developer_document_templates.html

Store gdoc revision ID and use it

Add a gdoc version ID to the YAML, as we are already doing with fileID. Then use it to warn/stop when uploading a new version (assumes #6 is fixed) and the document on the drive has been edited. Require force = TRUE or something like that.