Update README.md

[arvados.git] / sdk / R / README.md

diff --git a/sdk/R/README.md b/sdk/R/README.md
index 939e69b8023b31c8063d4be0253e665ad4071199..fe98e648ca97fbe613e6db98ca6b2c84e03cb089 100644 (file)
--- a/sdk/R/README.md
+++ b/sdk/R/README.md
@@ -63,41 +63,56 @@ This parameter can be set at any time using `setNumRetries`
 arv$setNumRetries(5)
 ```
 
-### Working with collections
+### Working with Aravdos projects
 
-#### Get a collection:
+##### Create project:
 
 ```r
-collection <- arv$collections_get("uuid")
+newProject <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
 ```
 
-Be aware that the result from `collections_get` is not a Collection class. The object returned from this method lets you access collection fields like “name” and “description”. The Collection class lets you access the files in the collection for reading and writing, and is described in the next section.
+##### Update project:
 
-#### List collections:
+```r
+updatedProject <- arv$project_update(name = "new project name", properties = newProperties, uuid = "projectUUID")
+```
+
+##### Delete a project:
 
 ```r
-# offset of 0 and default limit of 100
-collectionList <- arv$collections_list(list(list("name", "like", "Test%")))
+deletedProject <- arv$project_delete("uuid")
+```
 
-collectionList <- arv$collections_list(list(list("name", "like", "Test%")), limit = 10, offset = 2)
+#### Find a project:
 
-# count of total number of items (may be more than returned due to paging)
-collectionList$items_available
+##### Get a project:
 
-# items which match the filter criteria
-collectionList$items
+```r
+project <- arv$project_get("uuid")
 ```
 
-#### List all collections even if the number of items is greater than maximum API limit:
+##### List projects:
 
 ```r
-collectionList <- listAll(arv$collections_list, list(list("name", "like", "Test%")))
+list subprojects of a project
+projects <- arv$project_list(list(list("owner_uuid", "=", "aaaaa-j7d0g-ccccccccccccccc")))
+
+list projects which have names beginning with Example
+examples <- arv$project_list(list(list("name","like","Example%")))
 ```
 
-#### Delete a collection:
+##### List all projects even if the number of items is greater than maximum API limit:
 
 ```r
-deletedCollection <- arv$collections_delete("uuid")
+projects <- listAll(arv$project_list, list(list("name","like","Example%")))
+```
+
+### Working with collections
+
+#### Create a new collection:
+
+```r
+newCollection <- arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
 ```
 
 #### Update a collection’s metadata:
@@ -106,10 +121,41 @@ deletedCollection <- arv$collections_delete("uuid")
 collection <- arv$collections_update(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL, uuid =  "collectionUUID")
 ```
 
-#### Create a new collection:
+#### Delete a collection:
 
 ```r
-newCollection <- arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
+deletedCollection <- arv$collections_delete("uuid")
+```
+
+#### Find a collection:
+
+#### Get a collection:
+
+```r
+collection <- arv$collections_get("uuid")
+```
+
+Be aware that the result from `collections_get` is not a Collection class. The object returned from this method lets you access collection fields like “name” and “description”. The Collection class lets you access the files in the collection for reading and writing, and is described in the next section.
+
+#### List collections:
+
+```r
+# offset of 0 and default limit of 100
+collectionList <- arv$collections_list(list(list("name", "like", "Test%")))
+
+collectionList <- arv$collections_list(list(list("name", "like", "Test%")), limit = 10, offset = 2)
+
+# count of total number of items (may be more than returned due to paging)
+collectionList$items_available
+
+# items which match the filter criteria
+collectionList$items
+```
+
+#### List all collections even if the number of items is greater than maximum API limit:
+
+```r
+collectionList <- listAll(arv$collections_list, list(list("name", "like", "Test%")))
 ```
 
 ### Manipulating collection content
@@ -284,47 +330,6 @@ subcollection <- collection$get("location/to/folder")
 subcollection$copy("destination/folder")
 ```
 
-### Working with Aravdos projects
-
-#### Get a project:
-
-```r
-project <- arv$project_get("uuid")
-```
-
-#### List projects:
-
-```r
-list subprojects of a project
-projects <- arv$project_list(list(list("owner_uuid", "=", "aaaaa-j7d0g-ccccccccccccccc")))
-
-list projects which have names beginning with Example
-examples <- arv$project_list(list(list("name","like","Example%")))
-```
-
-#### List all projects even if the number of items is greater than maximum API limit:
-
-```r
-projects <- listAll(arv$project_list, list(list("name","like","Example%")))
-```
-
-##### Delete a project:
-
-```r
-deletedProject <- arv$project_delete("uuid")
-```
-
-##### Update project:
-
-```r
-updatedProject <- arv$project_update(name = "new project name", properties = newProperties, uuid = "projectUUID")
-```
-
-##### Create project:
-
-```r
-newProject <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
-```
 
 ### Help