R/rmodb
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated README.md

Browse Source
This commit is contained in:
Craig Williams
2020-10-02 13:20:49 +01:00
parent 907d848791
commit 5c7c2e71c9
1 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -1,23 +1,34 @@
# RMetaObjDB # RMODB (R Meta-Object Data Base)
<!-- badges: start --> <!-- badges: start -->
<!-- badges: end --> <!-- badges: end -->
RMetaObjDB implements a metadata-object database for storing R objects in MySQL. R objects are serialized into a binary memory buffer which is then written into a MySQL database along with metadata such as creation timestamp, update timestamp, owner, title etc. The metadata fields are customisable on creation of the database. the metadata fields are cleartext and queryable allowing objects to be found and returned. On returning an object, it is de-serialised using the reverseof the serialize to binary memory process. RMODB implements a metadata-object database for storing R objects in MySQL. R objects are serialized into a binary memory buffer which is then written into a MySQL database along with metadata such as creation timestamp, update timestamp, owner, title etc. The metadata fields are customisable on creation of the database and the fields are cleartext and queryable allowing objects to be found and returned by filtering on any metadata column or combination of columns. On returning an object, it is de-serialised using the reverse of the serialize to binary memory process.
## Versions
0.0.1 - Current development
## Installation ## Installation
You can install the released version of RMetaObjDB from [CRAN](https://CRAN.R-project.org) with: You can install the current version of modb from [Github](https://github.com/avsdev-uk/rmodb) using the devtools package:
``` r ``` r
install.packages("RMetaObjDB") devtools::install_github('avsdev-uk/rmodb')
```
You can install the a released version of modb from [CRAN](https://CRAN.R-project.org) with:
``` r
install.packages("rmodb")
``` ```
## Example ## Example
All methods within RMODB are documented in R using Roxygen.
This is a basic example which shows you how to solve a common problem: This is a basic example which shows you how to solve a common problem:
``` r ``` r
library(RMetaObjDB) library(rmodb)
## basic example code ## basic example code
``` ```