Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@grimbough
grimbough committed Jul 31, 2023
1 parent 173a827 commit b23687a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 20 deletions.
22 changes: 10 additions & 12 deletions README.Rmd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ output:
---

<!-- badges: start -->
[![Codecov test coverage](https://codecov.io/gh/grimbough/Rarr/branch/devel/graph/badge.svg)](https://app.codecov.io/gh/grimbough/Rarr?branch=devel)
<br>
Build Status:
[![Bioconductor Release](https://bioconductor.org/shields/build/release/bioc/Rarr.svg)](https://bioconductor.org/checkResults/release/bioc-LATEST/Rarr/)
[![Bioconductor Devel](https://bioconductor.org/shields/build/devel/bioc/Rarr.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/Rarr/)
| GitHub Actions | Bioconductor Build Sysytem | Test Coverage |
|:--------------:|:-------------:|:-----:|
| [![Package Checks](https://github.com/grimbough/Rarr/actions/workflows/main.yml/badge.svg)](https://github.com/grimbough/Rarr/actions/workflows/main.yml) | [![Bioconductor Status](https://bioconductor.org/shields/build/devel/bioc/Rarr.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/Rarr/) | [![Codecov test coverage](https://codecov.io/gh/grimbough/Rarr/branch/devel/graph/badge.svg)](https://app.codecov.io/gh/grimbough/Rarr?branch=devel) |
<!-- badges: end -->

```{r, config, echo = FALSE}
Expand Down Expand Up @@ -75,12 +73,12 @@ datatype support. It will be updated as progress is made.
|`uint16`| &#x2714; / &#x274C; | |
|`int32` | &#x2714; / &#x2714; | |
|`uint32`| &#x2714; / &#x274C; | Values outside the range of `int32` are converted to `NA`. Future plan is to allow conversion to `double` or use the [bit64](https://cran.r-project.org/package=bit64) package. |
|`int64`|&#x2714; / &#x274C; | Values outside the range of `int32` are converted to `NA`. Future plan is to allow conversion to `double` or use the [bit64](https://cran.r-project.org/package=bit64) package. |
|`uint64`|&#x2714; / &#x274C; | Values outside the range of `int32` are converted to `NA`. Future plan is to allow conversion to `double` or use the [bit64](https://cran.r-project.org/package=bit64) package. |
|`half` / `float16` |&#x2714; / &#x274C; | Converted to `double` in R. No effort is made to assess loss of precision due to conversion. |
|`single` / `float32` |&#x2714; / &#x274C; | Converted to `double` in R. No effort is made to assess loss of precision due to conversion. |
|`double` / `float64` |&#x2714; / &#x2714; | |
|`complex` |&#x274C; / &#x274C; | |
|`int64` | &#x2714; / &#x274C; | Values outside the range of `int32` are converted to `NA`. Future plan is to allow conversion to `double` or use the [bit64](https://cran.r-project.org/package=bit64) package. |
|`uint64`| &#x2714; / &#x274C; | Values outside the range of `int32` are converted to `NA`. Future plan is to allow conversion to `double` or use the [bit64](https://cran.r-project.org/package=bit64) package. |
|`half` / `float16` | &#x2714; / &#x274C; | Converted to `double` in R. No effort is made to assess loss of precision due to conversion. |
|`single` / `float32` | &#x2714; / &#x274C; | Converted to `double` in R. No effort is made to assess loss of precision due to conversion. |
|`double` / `float64` | &#x2714; / &#x2714; | |
|`complex` | &#x274C; / &#x274C; | |
|`timedelta` | &#x274C; / &#x274C; | |
|`datetime` | &#x274C; / &#x274C; | |
|`string` | &#x2714; / &#x2714; | |
Expand All @@ -95,7 +93,7 @@ datatype support. It will be updated as progress is made.
|`zlib / gzip`| &#x2714; / &#x2714; | Only system default compression level (normally 6) is enabled for writing. |
|`bzip2` | &#x2714; / &#x2714; | Only compression level 9 is enabled for writing. |
|`blosc` | &#x2714; / &#x2714; | Only `lz4` compression level 5 is enabled for writing. |
|`LZMA ` | &#x2714; / &#x2754; | |
|`LZMA ` | &#x2714; / &#x2714; | |
|`LZ4` | &#x2714; / &#x2714; | |
|`Zstd` | &#x274C; / &#x274C; | Algorithm is available via blosc for writing, but can't currently be access through the R interface |

Expand Down
14 changes: 6 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ Mike L. Smith

<!-- badges: start -->

[![Codecov test
coverage](https://codecov.io/gh/grimbough/Rarr/branch/devel/graph/badge.svg)](https://app.codecov.io/gh/grimbough/Rarr?branch=devel)
<br> Build Status: [![Bioconductor
Release](https://bioconductor.org/shields/build/release/bioc/Rarr.svg)](https://bioconductor.org/checkResults/release/bioc-LATEST/Rarr/)
[![Bioconductor
Devel](https://bioconductor.org/shields/build/devel/bioc/Rarr.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/Rarr/)
| GitHub Actions | Bioconductor Build Sysytem | Test Coverage |
|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------:|
| [![Package Checks](https://github.com/grimbough/Rarr/actions/workflows/main.yml/badge.svg)](https://github.com/grimbough/Rarr/actions/workflows/main.yml) | [![Bioconductor Status](https://bioconductor.org/shields/build/devel/bioc/Rarr.svg)](https://bioconductor.org/checkResults/devel/bioc-LATEST/Rarr/) | [![Codecov test coverage](https://codecov.io/gh/grimbough/Rarr/branch/devel/graph/badge.svg)](https://app.codecov.io/gh/grimbough/Rarr?branch=devel) |

<!-- badges: end -->

# Introduction to Rarr
Expand Down Expand Up @@ -101,7 +99,7 @@ zarr_overview(zarr_example)

## Type: Array

## Path: /tmp/RtmpQUTCwX/temp_libpath211960dc6958/Rarr/extdata/zarr_examples/column-first/int32.zarr
## Path: /mnt/data/R-lib/4.3-bioc_3.17/Rarr/extdata/zarr_examples/column-first/int32.zarr

## Shape: 30 x 20 x 10

Expand Down Expand Up @@ -300,7 +298,7 @@ is made.
| `zlib / gzip` | ✔ / ✔ | Only system default compression level (normally 6) is enabled for writing. |
| `bzip2` | ✔ / ✔ | Only compression level 9 is enabled for writing. |
| `blosc` | ✔ / ✔ | Only `lz4` compression level 5 is enabled for writing. |
| `LZMA` | ✔ / ❔ | |
| `LZMA` | ✔ / ✔ | |
| `LZ4` | ✔ / ✔ | |
| `Zstd` | ❌ / ❌ | Algorithm is available via blosc for writing, but can’t currently be access through the R interface |

Expand Down

0 comments on commit b23687a

Please sign in to comment.