methodResources <- discoveryDocument$resources
resourceNames <- names(methodResources)
- doc <- generateMethodsDocumentation(methodResources, resourceNames)
- arvadosAPIHeader <- generateAPIClassHeader()
- arvadosProjectMethods <- generateProjectMethods()
- arvadosClassMethods <- generateClassContent(methodResources, resourceNames)
- arvadosAPIFooter <- generateAPIClassFooter()
-
- arvadosClass <- c(doc,
+ methodDoc <- genMethodsDoc(methodResources, resourceNames)
+ classDoc <- genAPIClassDoc(methodResources, resourceNames)
+ arvadosAPIHeader <- genAPIClassHeader()
+ arvadosProjectMethods <- genProjectMethods()
+ arvadosClassMethods <- genClassContent(methodResources, resourceNames)
+ arvadosAPIFooter <- genAPIClassFooter()
+
+ arvadosClass <- c(methodDoc,
+ classDoc,
arvadosAPIHeader,
arvadosProjectMethods,
arvadosClassMethods,
NULL
}
-generateAPIClassHeader <- function()
+genAPIClassHeader <- function()
{
- c("#' @export",
- "Arvados <- R6::R6Class(",
+ c("Arvados <- R6::R6Class(",
"",
"\t\"Arvados\",",
"",
"\t\t},\n")
}
-generateProjectMethods <- function()
+genProjectMethods <- function()
{
- c("\t\tproject.get = function(uuid)",
+ c("\t\tprojects.get = function(uuid)",
"\t\t{",
"\t\t\tself$groups.get(uuid)",
"\t\t},",
"",
- "\t\tproject.create = function(group, ensure_unique_name = \"false\")",
+ "\t\tprojects.create = function(group, ensure_unique_name = \"false\")",
"\t\t{",
"\t\t\tgroup <- c(\"group_class\" = \"project\", group)",
"\t\t\tself$groups.create(group, ensure_unique_name)",
"\t\t},",
"",
- "\t\tproject.update = function(group, uuid)",
+ "\t\tprojects.update = function(group, uuid)",
"\t\t{",
"\t\t\tgroup <- c(\"group_class\" = \"project\", group)",
"\t\t\tself$groups.update(group, uuid)",
"\t\t},",
"",
- "\t\tproject.list = function(filters = NULL, where = NULL,",
+ "\t\tprojects.list = function(filters = NULL, where = NULL,",
"\t\t\torder = NULL, select = NULL, distinct = NULL,",
"\t\t\tlimit = \"100\", offset = \"0\", count = \"exact\",",
"\t\t\tinclude_trash = NULL)",
"\t\t\t limit, offset, count, include_trash)",
"\t\t},",
"",
- "\t\tproject.delete = function(uuid)",
+ "\t\tprojects.delete = function(uuid)",
"\t\t{",
"\t\t\tself$groups.delete(uuid)",
"\t\t},",
"")
}
-generateClassContent <- function(methodResources, resourceNames)
+genClassContent <- function(methodResources, resourceNames)
{
arvadosMethods <- Map(function(resource, resourceName)
{
arvadosMethods
}
-generateAPIClassFooter <- function()
+genAPIClassFooter <- function()
{
c("\t\tgetHostName = function() private$host,",
"\t\tgetToken = function() private$token,",
#NOTE: Arvados class documentation:
-generateMethodsDocumentation <- function(methodResources, resourceNames)
+genMethodsDoc <- function(methodResources, resourceNames)
{
methodsDoc <- unlist(unname(Map(function(resource, resourceName)
{
return(NULL)
methodName <- paste0(resourceName, ".", methodName)
- getMethodDocumentation(methodName, methodMetaData)
+ getMethodDoc(methodName, methodMetaData)
}, resource$methods, methodNames)
unlist(unname(methodDoc))
}, methodResources, resourceNames)))
+
+ projectDoc <- genProjectMethodsDoc()
+
+ c(methodsDoc, projectDoc)
+}
+
+genAPIClassDoc <- function(methodResources, resourceNames)
+{
+ c("#' Arvados",
+ "#'",
+ "#' Arvados class gives users ability to access Arvados REST API.",
+ "#'" ,
+ "#' @section Usage:",
+ "#' \\preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}",
+ "#'",
+ "#' @section Arguments:",
+ "#' \\describe{",
+ "#' \t\\item{authToken}{Authentification token. If not specified ARVADOS_API_TOKEN environment variable will be used.}",
+ "#' \t\\item{hostName}{Host name. If not specified ARVADOS_API_HOST environment variable will be used.}",
+ "#' \t\\item{numRetries}{Number which specifies how many times to retry failed service requests.}",
+ "#' }",
+ "#'",
+ "#' @section Methods:",
+ "#' \\describe{",
+ getAPIClassMethodList(methodResources, resourceNames),
+ "#' }",
+ "#'",
+ "#' @name Arvados",
+ "#' @examples",
+ "#' \\dontrun{",
+ "#' arv <- Arvados$new(\"your Arvados token\", \"example.arvadosapi.com\")",
+ "#'",
+ "#' collection <- arv$collections.get(\"uuid\")",
+ "#'",
+ "#' collectionList <- arv$collections.list(list(list(\"name\", \"like\", \"Test%\")))",
+ "#' collectionList <- listAll(arv$collections.list, list(list(\"name\", \"like\", \"Test%\")))",
+ "#'",
+ "#' deletedCollection <- arv$collections.delete(\"uuid\")",
+ "#'",
+ "#' updatedCollection <- arv$collections.update(list(name = \"New name\", description = \"New description\"),",
+ "#' \"uuid\")",
+ "#'",
+ "#' createdCollection <- arv$collections.create(list(name = \"Example\",",
+ "#' description = \"This is a test collection\"))",
+ "#' }",
+ "NULL",
+ "",
+ "#' @export")
+}
+
+getAPIClassMethodList <- function(methodResources, resourceNames)
+{
+ methodList <- unlist(unname(Map(function(resource, resourceName)
+ {
+ methodNames <- names(resource$methods)
+ paste0(resourceName,
+ ".",
+ methodNames[!(methodNames %in% c("index", "show", "destroy"))])
+
+ }, methodResources, resourceNames)))
- methodsDoc
+ hardcodedMethods <- c("projects.create", "projects.get",
+ "projects.list", "projects.update", "projects.delete")
+ 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)
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.
projects / arvados.git / blobdiff