This DataSHIELD Client Interface is a Python port of the original DataSHIELD Client Interface written in R (DSI). The provided interface can be implemented for accessing a data repository supporting the DataSHIELD infrastructure: controlled R commands to be executed on the server side are garanteeing that non disclosive information is returned to client side.
The search path for the DataSHIELD configuration file is the following:
- User general location:
~/.config/datashield/config.yaml - Current project specific location:
./.datashield/config.yaml
The configurations are merged: any existing entry is replaced by the new one (for instance server names must be unique).
The format of the DataSHIELD configuration file is:
servers:
- name: server1url: https://opal-demo.obiba.orguser: dsuserpassword: P@ssw0rd
- name: server2url: https://opal.example.orgtoken: your-access-token-hereprofile: default
- name: server3url: https://study.example.org/opaluser: dsuserpassword: P@ssw0rdprofile: customdriver: datashield_opal.OpalDriverEach server entry in the list must have:
name: Unique identifier for the serverurl: The server URL- Authentication: Either
userandpassword, ortoken(recommended) profile: DataSHIELD profile name (optional, defaults to "default")driver: Connection driver class name (optional, defaults to "datashield_opal.OpalDriver")