19704: Add readArvFile to README
authorPeter Amstutz <peter.amstutz@curii.com>
Thu, 1 Dec 2022 21:23:15 +0000 (16:23 -0500)
committerPeter Amstutz <peter.amstutz@curii.com>
Thu, 1 Dec 2022 21:23:15 +0000 (16:23 -0500)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

sdk/R/README.md

index 87d5fcb77f6931402081b796ce266920ec17df31..66b2d1f40d0ed5a87606c2697d13798de38902df 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: