Added documentation for hardcoded Arvados class project methods.

[arvados.git] / sdk / R / R / autoGenAPI.R

diff --git a/sdk/R/R/autoGenAPI.R b/sdk/R/R/autoGenAPI.R
index e0ad551e1e44b863a8e21cc89641a77f3b3c8bf6..4fa410c1a4cee92c66798ad6add2c042216b466c 100644 (file)
--- a/sdk/R/R/autoGenAPI.R
+++ b/sdk/R/R/autoGenAPI.R
@@ -15,12 +15,12 @@ generateAPI <- function()
     methodResources <- discoveryDocument$resources
     resourceNames   <- names(methodResources)
 
-    methodDoc <- generateMethodsDocumentation(methodResources, resourceNames)
-    classDoc <- generateAPIClassDocumentation(methodResources, resourceNames)
-    arvadosAPIHeader <- generateAPIClassHeader()
-    arvadosProjectMethods <- generateProjectMethods()
-    arvadosClassMethods <- generateClassContent(methodResources, resourceNames)
-    arvadosAPIFooter <- generateAPIClassFooter()
+    methodDoc <- genMethodsDoc(methodResources, resourceNames)
+    classDoc <- genAPIClassDoc(methodResources, resourceNames)
+    arvadosAPIHeader <- genAPIClassHeader()
+    arvadosProjectMethods <- genProjectMethods()
+    arvadosClassMethods <- genClassContent(methodResources, resourceNames)
+    arvadosAPIFooter <- genAPIClassFooter()
 
     arvadosClass <- c(methodDoc,
                       classDoc,
@@ -35,7 +35,7 @@ generateAPI <- function()
     NULL
 }
 
-generateAPIClassHeader <- function()
+genAPIClassHeader <- function()
 {
     c("Arvados <- R6::R6Class(",
       "",
@@ -69,7 +69,7 @@ generateAPIClassHeader <- function()
       "\t\t},\n")
 }
 
-generateProjectMethods <- function()
+genProjectMethods <- function()
 {
     c("\t\tprojects.get = function(uuid)",
       "\t\t{",
@@ -105,7 +105,7 @@ generateProjectMethods <- function()
       "")
 }
 
-generateClassContent <- function(methodResources, resourceNames)
+genClassContent <- function(methodResources, resourceNames)
 {
     arvadosMethods <- Map(function(resource, resourceName)
     {
@@ -131,7 +131,7 @@ generateClassContent <- function(methodResources, resourceNames)
     arvadosMethods
 }
 
-generateAPIClassFooter <- function()
+genAPIClassFooter <- function()
 {
     c("\t\tgetHostName = function() private$host,",
       "\t\tgetToken = function() private$token,",
@@ -315,8 +315,7 @@ getReturnObject <- function()
 
 #NOTE: Arvados class documentation:
 
-
-generateMethodsDocumentation <- function(methodResources, resourceNames)
+genMethodsDoc <- function(methodResources, resourceNames)
 {
     methodsDoc <- unlist(unname(Map(function(resource, resourceName)
     {
@@ -331,22 +330,24 @@ generateMethodsDocumentation <- function(methodResources, resourceNames)
                return(NULL)
 
             methodName <- paste0(resourceName, ".", methodName)
-            getMethodDocumentation(methodName, methodMetaData)
+            getMethodDoc(methodName, methodMetaData)
 
         }, resource$methods, methodNames)
 
         unlist(unname(methodDoc))
 
     }, methodResources, resourceNames)))
+
+    projectDoc <- genProjectMethodsDoc()
     
-    methodsDoc
+    c(methodsDoc, projectDoc)
 }
 
-generateAPIClassDocumentation <- function(methodResources, resourceNames)
+genAPIClassDoc <- function(methodResources, resourceNames)
 {
     c("#' Arvados",
       "#'",
-      "#' Arvados class gives users ability to manipulate collections and projects.",
+      "#' Arvados class gives users ability to access Arvados REST API.",
       "#'" ,
       "#' @section Usage:",
       "#' \\preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}",
@@ -402,7 +403,7 @@ getAPIClassMethodList <- function(methodResources, resourceNames)
     paste0("#' \t\\item{}{\\code{\\link{", sort(c(methodList, hardcodedMethods)), "}}}") 
 }
 
-getMethodDocumentation <- function(methodName, methodMetaData)
+getMethodDoc <- function(methodName, methodMetaData)
 {
     name        <- paste("#' @name", methodName)
     usage       <- getMethodUsage(methodName, methodMetaData)
@@ -456,6 +457,65 @@ getMethodDescription <- function(methodMetaData)
     c(requestDoc, argsDoc)
 }
 
+genProjectMethodsDoc <- function()
+{
+    #TODO: Manually update this documentation to reflect changes in discovery document.
+    c("#' projects.get is equivalent to groups.get method.",
+    "#' ",
+    "#' @usage arv$projects.get(uuid)",
+    "#' @param uuid The UUID of the Group in question.",
+    "#' @return Group object.",
+    "#' @name projects.get",
+    "NULL",
+    "",
+    "#' projects.create wrapps groups.create method by setting group_class attribute to \"project\".",
+    "#' ",
+    "#' @usage arv$projects.create(group, ensure_unique_name = \"false\")",
+    "#' @param group Group object.",
+    "#' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.",
+    "#' @return Group object.",
+    "#' @name projects.create",
+    "NULL",
+    "",
+    "#' projects.update wrapps groups.update method by setting group_class attribute to \"project\".",
+    "#' ",
+    "#' @usage arv$projects.update(group, uuid)",
+    "#' @param group Group object.",
+    "#' @param uuid The UUID of the Group in question.",
+    "#' @return Group object.",
+    "#' @name projects.update",
+    "NULL",
+    "",
+    "#' projects.delete is equivalent to groups.delete method.",
+    "#' ",
+    "#' @usage arv$project.delete(uuid)",
+    "#' @param uuid The UUID of the Group in question.",
+    "#' @return Group object.",
+    "#' @name projects.delete",
+    "NULL",
+    "",
+    "#' projects.list wrapps groups.list method by setting group_class attribute to \"project\".",
+    "#' ",
+    "#' @usage arv$projects.list(filters = NULL,",
+    "#'        where = NULL, order = NULL, distinct = NULL,",
+    "#'        limit = \"100\", offset = \"0\", count = \"exact\",",
+    "#'        include_trash = NULL, uuid = NULL, recursive = NULL)",
+    "#' @param filters ",
+    "#' @param where ",
+    "#' @param order ",
+    "#' @param distinct ",
+    "#' @param limit ",
+    "#' @param offset ",
+    "#' @param count ",
+    "#' @param include_trash Include items whose is_trashed attribute is true.",
+    "#' @param uuid ",
+    "#' @param recursive Include contents from child groups recursively.",
+    "#' @return Group object.",
+    "#' @name projects.list",
+    "NULL",
+    "")
+}
+
 #NOTE: Utility functions:
 
 # This function is used to split very long lines of code into smaller chunks.