getDocs: Get a list of available documents

In duncantl/RGoogleDocs: Primitive interface to Google Documents from R

Get a list of available documents

Description

This function retrieves the list of available documents from the Google Docs account. Depending on the service specified when creating the connection and authenticating the login, the documents may be all document types or just the spreadsheets.

One can specify http://code.google.com/apis/gdata/docs/2.0/reference.html#Queries in the search via the what parameter. At present, you have to specify the full URL yourself rather than using more convenient R functionality and syntax.

Usage

getDocs(curl = getConnection(auth), folders = TRUE,
         as.data.frame = FALSE, auth = getGoogleAuth(service = service), 
          what = GoogleURLs[service],
           ..., service = "writely")

Arguments

curl	the authenticated connection to the Google Docs account
folders	logical value indicating whether to include folders in the list of documents.
as.data.frame	a logical value indicating whether to return the information about each document as a row in a data frame or as individual GoogleDocument objects.
auth	authentication token obtained from calling getGoogleAuth which can be used to initialize a Curl handle to use as the connection.
what	the type of documents to fetch, e.g. documents or spreadsheets. One can specify a value in GoogleURLs or use a name from this vector.
...	additional arguments passed to getURL.
service	the name of the Google Docs service, e.g. "wise" or "writely"

Value

A list of GoogleDocument objects or a data frame.

Author(s)

Duncan Temple Lang

See Also

getGoogleDocsConnection searchDocs

Examples

if(exists("GoogleDocsPassword")) {
         # getGoogleDocsConnection("my login", "my password")
cat("Getting documents\n")
  con = getGoogleDocsConnection(names(GoogleDocsPassword), GoogleDocsPassword)

  getDocs(con)  # list of GoogleDocuments
  getDocs(con, TRUE) # a data frame

## Not run: 
  con = getGoogleDocsConnection("me", "password", service = "wise")
  getDocs(con)  # just the spreadsheets

## End(Not run)
    # Get just the word processing documents, i.e. not the spreadsheets, 
  d = getDocs(con, what = "https://docs.google.com/feeds/documents/private/full/-/document")
    # The above should be slightly faster than doing the subsetting in R.
  d = getDocs(con)
  d[sapply(d, is, "GoogleDocument")]

  spreadsheetsDocs = getDocs(con, what = "https://docs.google.com/feeds/documents/private/full/-/spreadsheet")

     # Get the starred spreadsheets
  starredSheets = getDocs(con, what = "https://docs.google.com/feeds/documents/private/full/-/spreadsheet/starred")


      # documents within the directory named MyDir
   o = getDocs(con, what = "https://docs.google.com/feeds/documents/private/full/-/MyDir")

}

duncantl/RGoogleDocs documentation built on Nov. 23, 2023, 4:22 p.m.