Skip to content
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.

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

4 write a readme #34

Merged
merged 2 commits into from
Feb 6, 2024
Merged
Changes from all commits
Commits
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
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,15 @@
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

The goal of iassetR is to ...
The goal of iassetR is to interact with the [iAsset](https://iasset.nl/en/) api using R.
Currently only reading from the iAsset API is possible.
But we intend to expand the scope to writing data as well if this is somewhat securely possible.

This package is developed for use in case of [VespaWatch](https://vespawatch.be/), which uses iAsset under the umbrella of the [RIPARIAS](https://www.riparias.be/) project.
Early in the development a wider use, beyond the even the limits of RIPARIAS, was envissioned resulting in a name change from vespawatchR to iassetR.

The current version of the package should be usable by all users of iAsset however keep in mind it has only been tested for vespawatch use.
When you encounter issues please raise an [issue](https://github.com/inbo/iassetR/issues/new).

## Installation

Expand Down
Loading