Skip to content

Commit

Permalink
Release 0.6.0 (#116)
Browse files Browse the repository at this point in the history
* Add an empty define for TILEDB_DEPRECATED as a short term measure

* Enable TileDB 2.0.0 in CI matrix

* Make Author email-less, and set Maintainer to R specific email

* Updated pkdown generated docs, updated README

* Version 0.6.0
  • Loading branch information
eddelbuettel authored May 3, 2020
1 parent c073612 commit 2a428ef
Show file tree
Hide file tree
Showing 133 changed files with 7,519 additions and 2,757 deletions.
2 changes: 2 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ jobs:
env: DOCKER_CNTR="eddelbuettel/rocker-tiledb:1.7.6"
- name: 1.7.7
env: DOCKER_CNTR="eddelbuettel/rocker-tiledb:1.7.7"
- name: 2.0.0
env: DOCKER_CNTR="eddelbuettel/rocker-tiledb:2.0.0"

env:
global:
Expand Down
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Package: tiledb
Type: Package
Title: Sparse and Dense Multidimensional Array Data Management
Version: 0.5.0
Author: TileDB <[email protected]>
Maintainer: TileDB <help@tiledb.com>
Version: 0.6.0
Author: TileDB, Inc.
Maintainer: TileDB <support@tiledb.com>
Description: The efficient multi-dimensional array management system
'TileDB' introduces a novel on-disk format that can effectively store
dense and sparse array data with support for fast updates and
Expand Down
39 changes: 18 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,42 +9,39 @@ engine](https://github.com/TileDB-Inc/TileDB) of [TileDB](https://tiledb.com/).

Note that the R interface to TileDB is under development, and the API is subject to change.

## [Documentation](https://tiledb-inc.github.io/TileDB-R/)
## Documentation

## Quickstart

TileDB needs to be installed first (from a package or from source)
for the TileDB R package to build and link correctly:

> install.packages("remotes")
> library(remotes)
> remotes::install_github("TileDB-Inc/TileDB-R")
...
> library(tiledb)
> tiledb_version()
major minor patch
1 7 5
> help(package=tiledb)
Documentation is available for [the R
package](https://tiledb-inc.github.io/TileDB-R/) as well as for the [TileDB
API](https://docs.tiledb.com/main/).

## Installation

TileDB needs to be installed first (from a package or from source)
for the TileDB R package to build and link correctly.

As the TileDB R package has not been published on [CRAN](https://cran.r-project.org/), it must be
installed from source.

The most recent released version can be installed from
[Github](https://github.com/TileDB-Inc/TileDB-R) using the package
[remotes](https://cran.r-project.org/package=remotes).

install.packages("remotes")
library(remotes)
remotes::install_github("TileDB-Inc/TileDB-R")
> if (!requireNamespace("remotes",quietly=TRUE)) install.packages("remotes")
> remotes::install_github("TileDB-Inc/TileDB-R")
...
> library(tiledb)
> tiledb_version()
major minor patch
2 0 0
> help(package=tiledb)

If the TileDB library is installed in a custom location, you need to pass the explicit path:

remotes::install_github("TileDB-Inc/TileDB-R",
args="--configure-args='--with-tiledb=/path/to/tiledb'")
> remotes::install_github("TileDB-Inc/TileDB-R",
args="--configure-args='--with-tiledb=/path/to/tiledb'")

Note that the TileDB R package is developed and tested against the latest stable (`v1.7.x`) version
Note that the TileDB R package is developed and tested against the latest stable (`v2.0.x`) version
of TileDB, but should also build against the newest development version.

## Quick Links
Expand Down
41 changes: 35 additions & 6 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,51 +7,80 @@ reference:
- starts_with("tiledb_ctx")
- starts_with("tiledb_is_supported_fs")
- starts_with("tiledb_ctx_set_tag")
- ends_with("_context")
- ends_with("tiledb_ctx-method")
- matches("tiledb_get_context")
- matches("tiledb_set_context")
- title: Config
contents:
- starts_with("tiledb_config")
- starts_with("`[`.tiledb_config")
- starts_with("as.vector.tiledb_config")
- starts_with("as.data.frame.tiledb_config")
- ends_with("tiledb_config-method")
- matches(",tiledb_config,ANY")
- title: Array
contents:
- starts_with("tiledb_array_create")
- starts_with("tiledb_dense")
- starts_with("tiledb_sparse")
- matches("tiledb_array")
- matches(",tiledb_dense")
- matches(",tiledb_sparse")
- matches("tiledb_subarray")
- title: ArraySchema
contents:
- starts_with("tiledb_array_schema")
- matches("r_to_tiledb_type")
- title: Attribute
contents:
- starts_with("tiledb_attr")
- starts_with("attr")
- ends_with("tiledb_attr-method")
- title: Filter
contents:
- starts_with("tiledb_filter")
- starts_with("filter")
- title: FilterList
contents:
- starts_with("tiledb_filterlist")
- starts_with("filterlist")
- matches("tiledb_filter_list")
- starts_with("filter_list")
- ends_with("filter_list-method")
- title: Domain
contents:
- starts_with("tiledb_domain")
- starts_with("tiledb_domain")
- starts_with("tiledb_ndim")
- ends_with("tiledb_domain-method")
- title: Dim
contents:
- starts_with("tiledb_dim")
- starts_with("dim")
- ends_with("tiledb_dim-method")
- ends_with("tiledb_dim")
- title: Group
contents:
- starts_with("tiledb_group")
- title: Object
desc: object management functions
contents:
- starts_with("tiledb_object")
- starts_with("tiledb_object")
- matches("is.anonymous")
- title: MetaData
desc: arrray metadata functionality
contents:
- ends_with("metadata")
- title: Stats
desc: performance stat collection functions
contents:
- starts_with("tiledb_stats")
- title: Version
- title: DataFrame
desc: data.frame functionality functions
contents:
- matches("as_data_frame")
- matches("fromDataFrame")
- starts_with("return.data.frame")
- matches("data.frame")
- title: Package
desc: package and version information
contents:
- starts_with("tiledb_version")
- matches("tiledb-package")
36 changes: 23 additions & 13 deletions docs/404.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 23 additions & 13 deletions docs/LICENSE-text.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2a428ef

Please sign in to comment.