Merge branch 'master' of git.curoverse.com:arvados into 11876-r-sdk

[arvados.git] / sdk / R / README

diff --git a/sdk/R/README b/sdk/R/README
index 6f1f2ce938fef085a30fdc72e359c15ad4f5fb59..8a0c31dce6131ec30dc8f1d66fbc00b7b4531aa7 100644 (file)
--- a/sdk/R/README
+++ b/sdk/R/README
@@ -43,6 +43,10 @@ collectionList <- arv$listCollections(list(list("name", "like", "Test%")), limit
 collectionList$items_available # count of total number of items (may be more than returned due to paging)
 collectionList$items # items which match the filter criteria
 
+#Next example will list all collections even when the number of items is greater than maximum API limit
+
+collectionList <- arv$listAllCollections(list(list("name", "like", "Test%")))
+
 --------------------------------------------------------------------------------------------------------------------------------
 
 #Delete a collection:
@@ -53,7 +57,7 @@ deletedCollection <- arv$deleteCollection("uuid")
 
 #Update a collection's metadata:
 
-updatedCollection <- arv$updateCollection("uuid", list(name = "My new name", description = "a brand new description"))
+updatedCollection <- arv$updateCollection("uuid", list(name = "New name", description = "New description"))
 
 --------------------------------------------------------------------------------------------------------------------------------
 
@@ -171,20 +175,22 @@ subcollection$remove("folderInsideSubcollection/")
 
 #Move file or folder inside collection
 
-file <- collection$get("location/to/my/file.cpp")
+#Directley from collection
 
-file$move("destination/file.cpp")
+collection$move("folder/file.cpp", "file.cpp")
 
-#Or subcollections
+#Or from file
 
-subcollection <- collection$get("location/to/folder")
+file <- collection$get("location/to/my/file.cpp")
+file$move("newDestination/file.cpp")
 
-subcollection$move("destination/folder")
+#Or from subcollection
 
-#Make sure to include folder name in destination
-#For example
-#file$move("destination/") will not work
+subcollection <- collection$get("location/to/folder")
+subcollection$move("newDestination/folder")
 
+#Make sure to include new file name in destination
+#In second example file$move("newDestination/") will not work
 
 --------------------------------------------------------------------------------------------------------------------------------
 WORKING WITH ARVADOS PROJECTS
@@ -201,6 +207,10 @@ arv$getProject("uuid")
 projects <- arv$listProjects(list(list("owner_uuid", "=", "aaaaa-j7d0g-ccccccccccccccc"))) # list subprojects of a project
 arv$listProjects(list(list("name","like","Example%"))) # list projects which have names beginning with Example
 
+#Next example will list all projects even when the number of items is greater than maximum API limit
+
+collectionList <- arv$listAllProjects(list(list("name","like","Example%")))
+
 --------------------------------------------------------------------------------------------------------------------------------
 
 #Delete a project: