-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🚧 Working on documentation for samples and biospecimens
- Loading branch information
1 parent
77c5cde
commit 2b5ee89
Showing
3 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.. _about_concepts: | ||
|
||
============== | ||
Concept Schema | ||
============== | ||
|
||
A key part of the ingest library is the intermediate model of the | ||
"concept schema". This concept schema is a representation of the data that is | ||
being ingested, and is used to generate the final schema that is used to create | ||
the tables in the target api. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
|
||
samples_and_specimens.rst |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
===================== | ||
Samples and Biospecimens | ||
===================== | ||
|
||
Although similarly named, samples and biospecimens refer to different things: | ||
|
||
- A **sample** is a physical piece of tissue, blood, or other material taken | ||
from a patient. | ||
- A **biospecimen** is a part of that sample, e.g. an aliquot of a sample. | ||
|
||
While samples and biospecimens are distinct concepts, they share much in common. | ||
In fact, when the ingest library was first written, its primary target API, | ||
the Kids First Data Service, only had a table for biospecimens. As a result, | ||
the ingest library's architecture provides for a biospecimen to share *all* the | ||
qualities of a sample. In fact, biospecimen is a child class of sample! | ||
|
||
This architecture allows the ingest library to be used against target APIs that, | ||
like the older versions of the Kids First Data Service, only have a table for | ||
biospecimens. | ||
|
||
A sample has qualities: | ||
|
||
* A sample may have ino | ||
|
||
A biospecimen takes on | ||
This | ||
is the smallest unit that a piece of biological material can take, as | ||
represented in the ingest library. | ||
|
||
Some |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,6 +40,7 @@ described. | |
:maxdepth: 1 | ||
|
||
value_principles | ||
concepts/index.rst | ||
extract_mapping | ||
transform | ||
load | ||
|