Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joundso/mainzelliste-connector

MainzellisteConnectoR
https://github.com/joundso/mainzelliste-connector

Last synced: about 1 month ago
JSON representation

MainzellisteConnectoR

Host: GitHub
URL: https://github.com/joundso/mainzelliste-connector
Owner: joundso
License: gpl-3.0
Created: 2021-04-07T10:47:55.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-06-14T08:06:02.000Z (over 3 years ago)
Last Synced: 2023-03-04T02:03:24.063Z (almost 2 years ago)
Language: R
Size: 37.1 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # MainzellisteConnectoR

[![codecov](https://codecov.io/gh/joundso/mainzelliste-connector/branch/master/graph/badge.svg)](https://codecov.io/gh/joundso/mainzelliste-connector)

[![pipeline status](https://git.uk-erlangen.de/mik-diz/mik-diz-tea/r-packages/mainzelliste-connector/badges/master/pipeline.svg)](https://git.uk-erlangen.de/mik-diz/mik-diz-tea/r-packages/mainzelliste-connector/commits/master)

[![coverage report](https://git.uk-erlangen.de/mik-diz/mik-diz-tea/r-packages/mainzelliste-connector/badges/master/coverage.svg)](https://git.uk-erlangen.de/mik-diz/mik-diz-tea/r-packages/mainzelliste-connector/commits/master)

[![CRAN Status Badge](https://www.r-pkg.org/badges/version-ago/MainzellisteConnectoR)](https://cran.r-project.org/package=MainzellisteConnectoR)

[![Cran Checks](https://cranchecks.info/badges/worst/MainzellisteConnectoR)](https://cran.r-project.org/web/checks/check_results_MainzellisteConnectoR.html)

The R package `MainzellisteConnectoR` provides utility functions used to access a running Mainzelliste-Instance.

## Installation

The development version can be installed using

```r

install.packages("devtools")

devtools::install_github("joundso/mainzelliste-connector", ref = "development")

```

## Basic functions

### Pseudonymize a value(set)

#### Without setting the environment variables

```R

res <- MainzellisteConnectoR::pseudonymize(

  MAINZELLISTE_BASE_URL = "https://your-organization.org",

  MAINZELLISTE_API_KEY = "123456789abcdef",

  MAINZELLISTE_FIELDNAME = "ishid",

  mainzelliste_fieldvalue = c(123, 456, "abc")

)

## Result (e.g.):

res

#       123        456        abc

# "000C30WP" "T4ECWT4Q" "Y2FAYH5D"

```

#### With setting the environment variables

Simply fill a `.env` file:

```sh

## Save this e.g. as '.env'

MAINZELLISTE_BASE_URL=https://your-organization.org

MAINZELLISTE_API_KEY=123456789abcdef

MAINZELLISTE_FIELDNAME=ishid

```

then read in the file and assign all variables to the environment:

```R

## Read in the '.env' file:

DIZutils::set_env_vars(env_file = "./.env")

## And use the smaller function call:

res <- MainzellisteConnectoR::pseudonymize(

  mainzelliste_fieldvalue = c(123, 456, "abc"),

  from_env = TRUE

)

## Result (e.g.):

res

#       123        456        abc

# "000C30WP" "T4ECWT4Q" "Y2FAYH5D"

```

#### Accessing the result

```R

## Result (e.g.):

res

#       123        456        abc

# "000C30WP" "T4ECWT4Q" "Y2FAYH5D"

## The result is a named list and can be accessed like this:

## Access the element with the name "123" (and receive a single-item-list):

res["123"]

# Result:

#        123 

#  "000C30WP"

## Access the element with the name "123" (and receive a string):

res[["123"]]

# Result:

# "000C30WP"

## Access the first element (and receive a string):

res[[1]]

# Result:

# "000C30WP"

```

### De-Pseudonymize a value(set)

This is exactly the same like pseudonymizing, but use `MainzellisteConnectoR::depseudonymize` instead of `MainzellisteConnectoR::pseudonymize`.

## More Infos

* About the Mainzelliste in its [Repo](https://bitbucket.org/medicalinformatics/mainzelliste/src/master) or its [Wiki](https://bitbucket.org/medicalinformatics/mainzelliste/wiki/Home)

* About MIRACUM: 

* About the Medical Informatics Initiative: