renku-bio
This plugin extends Renku to easily annotate biological samples in Renku metadata. Samples can be annotated on either the project or dataset metadata (using --dataset).
Installation
The development version can be installed as a local Python package by running the following command from the root of the repo:
pip install -e .
The stable version is on PyPI and can be installed with pip:
pip install renku-bio
Usage
A CLI is available with entrypoint renku bio the gif belows demonstrates how to use it:
[Click to expand] Full command from example above
➜ renku bio add-sample \
--description "Culture of liver cells from an adult mouse" \
--age 2 \
--taxon "Mus musculus" \
--collector "SDSC" \
--gender Male mouse_liver \
--location "Lausanne" \
--date 2022-08-10
After adding the biosample above, the project metadata graph would have the following structure:
The new "BioSample" node was created by renku bio add-sample. The information provided for sampling location, collector organization and taxon are enriched using third party APIs. For example, the "Taxon" node now has "scientificName", "taxonRank" and "parentTaxon" in addition to the name provided.
[Click to expand] Compact view of the full biosample metadata
[
{
"@id": "https://renkulab.io/projects/renku-bio/mouse_liver",
"@type": "http://bioschemas.org/BioSample",
"http://schema.org/dateCreated": "2022-08-10",
"http://bioschemas.org/collector": {
"@id": "https://ror.org/02hdt9m26",
"@type": "http://schema.org/Organization",
"http://schema.org/name": "Swiss Data Science Center"
},
"http://bioschemas.org/isControl": false,
"http://bioschemas.org/locationCreated": {
"@id": "https://renkulab.io/projects/renku-bio/mouse_liver/loc",
"@type": "http://schema.org/Place",
"http://schema.org/latitude": 46.5218269,
"http://schema.org/longitude": 6.6327025,
"http://schema.org/name": "Lausanne, District de Lausanne, Vaud, Schweiz/Suisse/Svizzera/Svizra"
},
"http://bioschemas.org/samplingAge": 2,
"http://bioschemas.org/taxonomicRange": {
"@id": "https://renkulab.io/projects/renku-bio/mouse_liver/tax",
"@type": "http://bioschemas.org/Taxon",
"http://bioschemas.org/parentTaxon": "Mus",
"http://bioschemas.org/scientificName": "Mus musculus",
"http://bioschemas.org/taxonRank": "species",
"http://schema.org/name": "house mouse"
},
"http://schema.org/description": "Culture of liver cells from an adult mouse",
"http://schema.org/gender": "Male",
"http://schema.org/name": "mouse_liver"
}
]
Current state:
Checklist:
- Interactively prompt user to select relevant API result (ROR, EBI, OSM)
- Use dataset annotations instead of project
- Use Renku API to fetch metadata instead of CLI + subprocess
- Change console entrypoint to make into a renku plugin
- Add support for experimental assay (potentially with LabProtocol)
- Restructure CLI into renku bio {sample,assay} {add,ls,rm,show}
- PoC to query a list of datasets (or projects) based on BioSample annotations.
1 maintainer
Metadata
1 maintainer
Release files for renku-bio 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| renku-bio-0.2.0.tar.gz | 12.3 kB | Without provenance | Details for renku-bio-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| renku_bio-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for renku_bio-0.2.0-py3-none-any.whl |
Total release size: 24.1 kB
Release files / renku-bio-0.2.0.tar.gz
| Download URL | renku-bio-0.2.0.tar.gz |
|---|---|
| Size | 12.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b1b20a01c54f83993f0510cecbe9321493c2c0530479c37e12a12b6eb9d6cffb
|
|
BLAKE2b-256 checksum How to use checksums |
f2e2bd435f9b8d14c7ec24bd1613a40bdbec1914f39cc96c0c66eceebb666b45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.9.7 Linux/5.15.0-50-generic
|
Release files / renku_bio-0.2.0-py3-none-any.whl
| Download URL | renku_bio-0.2.0-py3-none-any.whl |
|---|---|
| Size | 11.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
12372b7ea87579e404e9322c8f7d57eb15e922d5e0b7d4d2b63eb82fab65c4fa
|
|
BLAKE2b-256 checksum How to use checksums |
34b5487cd38ff258f2450d4fce915f2717a0e8786178424efc626312af90aa58
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.2.1 CPython/3.9.7 Linux/5.15.0-50-generic
|
Security for renku-bio 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
