Skip to main content

# Biometalib

Biometalib is a set of useful libraries and tools for working with SRA biological metadata.

## Installation

This library is designed for python 3+ and can be installed with pip or conda.

### Pip

Biometalib can be installed using pip.

`bash pip install -y biometalib `

Or the latest version can be installed by pip.

`bash pip install git+https://github.com/jfear/sramongo pip install git+https://github.com/jfear/biometalib `

### Conda [Suggested]

First make sure you have a working installation of Anaconda, I suggest [Miniconda](https://conda.io/miniconda.html).

`bash conda install -c jfear biometalib `

## Attribute Selector

Attribute selector is a helper script for selecting which attributes you want to focus on for a project. The biological metadata submitted by users contain a variety of different types of attributes. Sometimes these include things like misspellings or different forms of a word, it also includes attributes that are unique to a single project. This tool is to be used to quickly curate these columns. Attribute selector uses a YAML formatted file to store attribute decisions.

In the YAML file, selected attributes will be the keys. When merging multiple attributes into a single selected attribute they will be stored as values. For example:

` sex: - sex - Sex - gender `

Here the selected attribute sex has the attributes Sex and gender associated with it. There is also a special selected attribute ignore that will store a list of attributes that you want to ignore.

Using the BioSample selection sheet I have created a starting YAML that can be used when running attribute_selector.

To run the attributes selector on my public version of the Biometa database type:

`bash # Download example YAML $ wget -O my_attribute_selection.yaml https://raw.githubusercontent.com/jfear/biometalib/master/data/flybase_example.yaml $ attribute_selector --host mongo.geneticsunderground.com --port 27022 --db sra --username sra --password oliver --authenticationDatabase user-data --config my_attribute_selection.yaml `

attribute_selector is an interactive command line tool. Iterates overall attribute column names that are not already selected attributes in the YAML. The current attribute is displayed in red. At the prompt you can type:

  • k to set the current attribute as a selected attribute [keep]

  • r to rename the current attribute, this will set the current attribute as value of the renamed selected attribute [rename]

  • i adds current attribute to ignore list [ignore]

  • e show example values listed under the current attribute [example]

  • s show attributes with similar names (fuzzy string match). Here selected attributes will appear in yellow [similar]

  • n skip and go to the next attribute [next]

  • quit exit out of the program, but save progress.

Metadata

Release files for biometalib 0.0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for biometalib 0.0.4
File Size Uploaded Provenance
biometalib-0.0.4.tar.gz 13.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for biometalib 0.0.4
File Interpreter ABI Platform
biometalib-0.0.4-py3-none-any.whl Python 3 none any Details

Total release size: 31.2 kB

Release files / biometalib-0.0.4.tar.gz

Download URL biometalib-0.0.4.tar.gz
Size 13.3 kB
Tags Source
SHA-256 checksum
How to use checksums
5a8a023acc35945be782581bb0da2b8a8fa0cc766d3c7e9d5af794932c8f5acf
BLAKE2b-256 checksum
How to use checksums
b3e7df161442f9af6ea3228fad0c94a08f32100ec645e3bdea350b1025773b93
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / biometalib-0.0.4-py3-none-any.whl

Download URL biometalib-0.0.4-py3-none-any.whl
Size 17.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89792c0e7f1671d90e636f7fe322697029df1e8c966793a6aa41b224fd97f762
BLAKE2b-256 checksum
How to use checksums
f55b47af964464d81973bd504739f8cadeaab6010551f8b6c72924c8f2d34010
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for biometalib 0.0.4

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.

Release history Release notifications | RSS feed

This release

0.0.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page