Skip to content

Update URLs in vignettes #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mojaveazure merged 1 commit into from
Apr 4, 2025
Merged

Update URLs in vignettes #813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 8 additions & 9 deletions vignettes/introduction.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ css: water.css
title: First Steps with TileDB
---

```{=html}
<!--
%\VignetteIndexEntry{Introduction to TileDB}
%\VignetteEngine{simplermarkdown::mdweave_to_html}
%\VignetteEncoding{UTF-8}
-->
```

This document introduces TileDB via several simple examples. A
corresponding document with more complete [API
documentation](documentation.html) is also available.
Expand All @@ -27,7 +26,7 @@ Documentation for the TileDB R package is available via the `help()`
function from within R as well as via the [package
documentation](https://tiledb-inc.github.io/TileDB-R/) and an
[introductory
notebook](https://github.com/TileDB-Inc/TileDB-R/tree/main/inst/notebooks/).
notebook](https://github.com/TileDB-Inc/TileDB-R/tree/main/inst/notebooks).
Documentation about TileDB itself is [also
available](https://docs.tiledb.com/main/).

Expand Down Expand Up @@ -146,12 +145,12 @@ array.
>
```

This also illustrated the effect of setting `as.data.frame=TRUE` when
opening the array.
This also illustrated the effect of setting `return_as = "data.frame"`
when opening the array.

This scheme can be generalized to variable cells, or cells where N>1, as
we can expand each (atomistic) value over corresponding row and column
indices.
This scheme can be generalized to variable cells, or cells where N\>1,
as we can expand each (atomistic) value over corresponding row and
column indices.

The column types correspond to the attribute typed in the array schema,
subject to the constraint mentioned above on R types. (The char comes in
Expand Down Expand Up @@ -288,7 +287,7 @@ The TileDB R package is documented via R help functions (*e.g.*
`help("tiledb_array")` shows information for the `tiledb_array()`
function) as well as via a [website regrouping all
documentation](https://tiledb-inc.github.io/TileDB-R/). Extended [API
documentation](https://tiledb-inc.github.io/TileDB-R/documentation.html)
documentation](https://tiledb-inc.github.io/TileDB-R/articles/documentation.html)
is available, as is a
[examples/](https://github.com/TileDB-Inc/TileDB-R/tree/main/inst/examples)
directory.
Expand Down
2 changes: 1 addition & 1 deletion vignettes/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ and [overall documentation](https://docs.tiledb.com/developer/) as well as a [su

[cran_tiledb]: https://cran.r-project.org/package=tiledb
[tiledb-r_docs]: https://tiledb-inc.github.io/TileDB-R/
[api_documentation]: https://tiledb-inc.github.io/TileDB-R/documentation.html
[api_documentation]: https://tiledb-inc.github.io/TileDB-R/articles/documentation.html
[tiledb_examples]: https://github.com/TileDB-Inc/TileDB-R/tree/main/inst/examples
[tiledb_notebook]: https://github.com/TileDB-Inc/TileDB-R/tree/main/inst/notebooks

Expand Down
Loading