Skip to content

Commit

Permalink
Feature/issue 394 drs plus connect docs v1 (#406)
Browse files Browse the repository at this point in the history
* adding information for DRS + Data connect

* adding notebook example
  • Loading branch information
MichaelLukowski authored Sep 11, 2024
1 parent 8164202 commit 0423947
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
3 changes: 3 additions & 0 deletions pages/more-background-on-compact-identifiers/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,6 @@ tags:
- name: Example DRS Client Compact Identifier-Based URI Resolution Process - Registering a new Compact Identifier for Your DRS Server
description:
$ref: ./tags/ExampleRegisterIdentifier.md
- name: Example How To Handle Extra Metadata for DRS Objects
description:
$ref: ./tags/DRSPlusDataConnect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## DRS and Data Connect

With DRS objects it may be necessary to attach additional metadata to your objects. We believe that a change to the API of DRS to include metadata is not in the spirit of the DRS spec and in general DRS should have no knowledge of the metadata associated with the objects. We have found that a good GA4GH standard to support this is Data Connect (https://github.com/ga4gh-discovery/data-connect). The general approach would be to have a Data Connect service on your platform and to include "tables" with the ID matching your DRS ID for the same object. This means that if you have metadata associated with an object id `abcd` (ex. additional information about Compound Objects) all you need to do is request the information from the Data Connect client at `/tables/abcd/info`. There are optional functionalities of Data Connect, such as querying of tables, but we do not explore them or give any recommendations here.

Here is an example of using Data Connect with DRS in the fasp-scripts repository (https://github.com/ga4gh/fasp-scripts/blob/master/notebooks/drs/DRS%20File%20Data.ipynb). In this notebook we can see that data connect is used to get DRS IDs from a platform. Those DRS IDs are then used to gather aditional information about the file that might be necessary for analysis. This is just one example of how DRS and Data Connect can interact with each other to gather information about data on a platform.

0 comments on commit 0423947

Please sign in to comment.