R/user_folder_documents.r

In ropensci/RMendeley: Interface to Mendeley API methods

#'folderDocs - Returns list of documents in a specific folder.
#'
#'
#'@param mc OAuth object of class MendeleyCredentials
#'@param  folder_id ...
#'@param  page ...
#'@param  items ...
#'@param curl If using in a loop, call getCurlHandle() first and pass
#'  the returned value in here (avoids unnecessary footprint)
#' @param ... optional additional curl options (debugging tools mostly).
#'@export
#'@examples \dontrun{
#' folderDocs(mc, '22468211')
#'}
#' @author Karthik Ram \email{karthik.ram@@gmail.com}
folderDocs <- function(mc = NULL, folder_id = NULL, page = NULL,
    items = NULL, ..., curl = getCurlHandle()) {
if (!is(mc, "MendeleyCredentials"))
        stop("Invalid or missing Mendeley credentials. ?mendeley_auth for more information.",
            call. = FALSE)
    if (is.null(folder_id)) {
        stop("You did not enter a folder ID.", call. = FALSE)
    }
    folder_doc_url <- sprintf("http://api.mendeley.com/oapi/library/folders/%s/", folder_id)
    group_docs <- OAuthRequest(mc, folder_doc_url, , "GET")
    group_docs <- fromJSON(group_docs)
    lapply(group_docs$document_ids,
           function(x)
              new("MendeleyDocumentID", x, folder = new("MendeleyFolderID", group_docs$folder_id)))
    return(group_docs)
}