19889: Serve live logs via webdav.
[arvados.git] / sdk / R / README.md
index 87d5fcb77f6931402081b796ce266920ec17df31..939e69b8023b31c8063d4be0253e665ad4071199 100644 (file)
@@ -180,6 +180,19 @@ fileContent <- arvadosFile$read("text")
 fileContent <- arvadosFile$read("raw", offset = 1024, length = 512)
 ```
 
+#### Read various file types:
+
+Chooses file type based on file name extension.  Recognized file extensions: 'txt', 'xlsx', 'csv', 'tsv', 'fasta', 'dat', 'bin', 'rds', 'rdata'.
+
+```r
+collection <- Collection$new(arv, collectionUUID)
+readFile <- collection$readArvFile(arvadosFile, istable = 'yes')                    # table
+readFile <- collection$readArvFile(arvadosFile, istable = 'no')                     # text
+readFile <- collection$readArvFile(arvadosFile)                                     # xlsx, csv, tsv, rds, rdata
+readFile <- collection$readArvFile(arvadosFile, fileclass = 'fasta')                # fasta
+readFile <- collection$readArvFile(arvadosFile, Ncol= 4, Nrow = 32)                 # binary data.frame, only numbers
+readFile <- collection$readArvFile(arvadosFile, Ncol = 5, Nrow = 150, istable = "factor") # binary data.frame with factor or text
+```
 
 #### Get ArvadosFile or Subcollection size:
 
@@ -348,35 +361,14 @@ This will create a tarball of the ArvadosR package in the current directory.
 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
 
-[![Join the chat at https://gitter.im/arvados/community](https://badges.gitter.im/arvados/community.svg)](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.