-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✨ Add Sample Concept #683
✨ Add Sample Concept #683
Conversation
kf_lib_data_ingest/target_api_plugins/kids_first_dataservice.py
Outdated
Show resolved
Hide resolved
e2a6460
to
18250dd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking really good! Just minor comments on the docs
@@ -429,6 +429,79 @@ def submit(cls, host, body): | |||
return submit(host, cls, body) | |||
|
|||
|
|||
class Sample: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should add a class docstring that explains BIOSPECIMEN_GROUP
was a previously existing concept that has been used in ingest packages and that's why some fields (external_id) in the Biospecimen and/or Sample class first extract from SAMPLE
and then secondarily extract from BIOSPECIMEN_GROUP
Tests might be failing bc you also have to add kf-lib-data-ingest/kf_lib_data_ingest/target_api_plugins/kids_first_dataservice.py Line 1005 in 8ccf9ec
|
kf_lib_data_ingest/target_api_plugins/kids_first_dataservice.py
Outdated
Show resolved
Hide resolved
66f6fe1
to
23054cb
Compare
do you mean in all_targets? it's there :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Ok so looks like I was wrong before. Tests are failing bc the Sample class needs the following method definition like the other classes:
@classmethod
def submit(cls, host, body):
return submit(host, cls, body)
🚨 Don't mess up formmatting 🚨 Don't mess up formmatting point to sample when building sample key concept 🐛 Add submit function to sample
3564e05
to
e5ea014
Compare
🚧 Working on documentation for samples and biospecimens 📝 Document samples and specimens 🔥 Remove test text 🚨 Enable black linting 📝 re-word docs for better clarity Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/samples_and_specimens.rst Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/samples_and_specimens.rst Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/samples_and_specimens.rst Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/samples_and_specimens.rst Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/samples_and_specimens.rst Co-authored-by: Natasha Singh <[email protected]> Update docs/source/design/concepts/index.rst Co-authored-by: Natasha Singh <[email protected]> 🚨 Keep docs under 80 character line length 🚨 Documentation line length
e5ea014
to
3206940
Compare
## Release 1.21.0 ### Summary - Emojis: ✨ x2, ? x2 - Categories: Additions x2, Other Changes x2 ### New features and changes - [#686](#686) - ✨ D3B-586 sample relationship - [7cb601c](7cb601c) by [chris-s-friedman](https://github.com/chris-s-friedman) - [#683](#683) - ✨ Add Sample Concept - [026ed61](026ed61) by [chris-s-friedman](https://github.com/chris-s-friedman) - [#684](#684) - 🔧 add ucsf center - [469d097](469d097) by [HuangXiaoyan0106](https://github.com/HuangXiaoyan0106) - [#680](#680) - 📝 add Variantyx sequencer - [8ccf9ec](8ccf9ec) by [HuangXiaoyan0106](https://github.com/HuangXiaoyan0106)
Add Concept for Sample
This PR adds the concept for Sample. The approach for adding sample is to give it many of the same entities of biospecimen that make sense, such as shipping information, volume, etc and then make sample a parent to biospecimen, to indicate the relationship between biospecimen and sample. In the kf target api config, biospecimen and sample may be used interchangeable with preference given towards the sample entry.
Documentation for concepts is also added to the documentation site.