alphapepttools.data.available_data#

alphapepttools.data.available_data()#

List all available proteomics studies

Returns the global StudyCollection containing all pre-configured proteomics datasets available for download through alphapepttools. The collection provides metadata about each study including data type, search engine, and citations.

Return type:: StudyCollection
Returns:: A StudyCollection object containing metadata of all accessible studies

Examples

View available studies:

import alphapepttools as at

# Get the collection of available studies
studies = at.data.available_data()

# Display as DataFrame
print(studies.df)

# Check number of available studies
print(f"Total studies available: {len(studies)}")

Access a specific study:

import alphapepttools as at

# Get collection and retrieve specific study
studies = at.data.available_data()
pelsa_study = studies.get_study("pelsa_report_diann")

# Download the study data
file_path = pelsa_study.download()

Notes

The available studies are configured in the ‘datasets.yaml’ file that ships with alphapepttools. This collection is loaded once at module import and cached for efficiency.

alphapepttools.data.available_data

Contents

alphapepttools.data.available_data#