Skip to content

Commit 5196cff

Browse files
committed
chore: docs site updated
1 parent 6f1809e commit 5196cff

147 files changed

Lines changed: 11408 additions & 385 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ aggregation and assignment return a result object; DataSHIELD setup status check
2222
configuration comparision),
2323
* `DSResult` wraps access to the result, which can be fetched either synchronously or asynchronously
2424
depending on the capabilities of the data repository server.
25+
* `DSSession` represents the remote R session and is used to get its state when it is started.
2526

2627
All classes are *virtual*: they cannot be instantiated directly and instead must be subclassed. See [DSOpal](https://datashield.github.io/DSOpal/) for a reference implementation of DSI based on the [Opal](https://www.obiba.org/pages/products/opal/) data warehouse. See also [DSLite](https://datashield.github.io/DSLite/) for a server-less implementation of DSI for local datasets.
2728

@@ -33,6 +34,7 @@ In addition to these S4 classes, DSI provides functions to handle a list of remo
3334

3435
* `datashield.login` and `datashield.logout` will make use of the `DSDriver` paradigm to create `DSConnection`s
3536
to the data repositories,
37+
* `datashield.sessions` will ensure that the remote R sessions are up and running before any operation in the remote R sessions.
3638
* `datashield.aggregate` and `datashield.assign` will perform typical DataSHIELD operations on `DSConnection`s,
3739
which result will be fetched through `DSResult` objects,
3840
* `datashield.connections`, `datashield.connections_default` and `datashield.connections_find` are functions

_pkgdown.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ template:
22
bootstrap: 5
33
params:
44
bootswatch: simplex
5+
url: https://datashield.github.io/DSI/

docs/404.html

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/LICENSE.html

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/authors.html

Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/deps/bootstrap-5.3.1/bootstrap.min.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)