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:
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
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
Complete documentation, including the [User Guide](https://doc.arvados.org/user/index.html), [Installation documentation](https://doc.arvados.org/install/index.html), [Administrator documentation](https://doc.arvados.org/admin/index.html) and
[API documentation](https://doc.arvados.org/api/index.html) is available at http://doc.arvados.org/
-If you wish to build the Arvados documentation from a local git clone, see
-[doc/README.textile](doc/README.textile) for instructions.
-
## Community
-[](https://gitter.im/arvados/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-
-The [Arvados community channel](https://gitter.im/arvados/community)
-channel at [gitter.im](https://gitter.im) is available for live
-discussion and support.
-
-The [Arvados developement channel](https://gitter.im/arvados/development)
-channel at [gitter.im](https://gitter.im) is used to coordinate development.
-
-The [Arvados user mailing list](http://lists.arvados.org/mailman/listinfo/arvados)
-is used to announce new versions and other news.
-
-All participants are expected to abide by the [Arvados Code of Conduct](CODE_OF_CONDUCT.md).
+Visit [Arvados Community and Getting Help](https://doc.arvados.org/user/getting_started/community.html).
## Reporting bugs
[Report a bug](https://dev.arvados.org/projects/arvados/issues/new) on [dev.arvados.org](https://dev.arvados.org).
-## Development and Contributing
-
-See [CONTRIBUTING](CONTRIBUTING.md) for information about Arvados development and how to contribute to the Arvados project.
-
-The [development road map](https://dev.arvados.org/issues/gantt?utf8=%E2%9C%93&set_filter=1&gantt=1&f%5B%5D=project_id&op%5Bproject_id%5D=%3D&v%5Bproject_id%5D%5B%5D=49&f%5B%5D=&zoom=1) outlines some of the project priorities over the next twelve months.
-
## Licensing
-Arvados is Free Software. See [COPYING](COPYING) for information about the open source licenses used in Arvados.
+Arvados is Free Software. See [Arvados Free Software Licenses](https://doc.arvados.org/user/copying/copying.html) for information about the open source licenses used in Arvados.
projects / arvados.git / blobdiff