Eido Built-in Filters API
Overview
Section titled “Overview”Eido provides built-in filter functions that can transform PEP projects into different output formats. These filters are useful for converting PEPs to various representations like YAML, CSV, or other formats.
Available Filters
Section titled “Available Filters”Eido includes several built-in filters for converting and exporting PEP data:
- basic_pep_filter: Returns the basic PEP representation
- yaml_pep_filter: Converts PEP to YAML format
- csv_pep_filter: Exports sample tables as CSV
- yaml_samples_pep_filter: Exports only sample data as YAML
API Reference
Section titled “API Reference”Filter Functions
Section titled “Filter Functions”basic_pep_filter
Section titled “basic_pep_filter”def basic_pep_filter(p, **kwargs) -> Dict[str, str]Basic PEP filter, that does not convert the Project object.
This filter can save the PEP representation to file, if kwargs include path.
:param peppy.Project p: a Project to run filter on
yaml_pep_filter
Section titled “yaml_pep_filter”def yaml_pep_filter(p, **kwargs) -> Dict[str, str]YAML PEP filter, that returns Project object representation.
This filter can save the YAML to file, if kwargs include path.
:param peppy.Project p: a Project to run filter on
csv_pep_filter
Section titled “csv_pep_filter”def csv_pep_filter(p, **kwargs) -> Dict[str, str]CSV PEP filter, that returns Sample object representations
This filter can save the CSVs to files, if kwargs include
sample_table_path and/or subsample_table_path.
:param peppy.Project p: a Project to run filter on
yaml_samples_pep_filter
Section titled “yaml_samples_pep_filter”def yaml_samples_pep_filter(p, **kwargs) -> Dict[str, str]YAML samples PEP filter, that returns only Sample object representations.
This filter can save the YAML to file, if kwargs include path.
:param peppy.Project p: a Project to run filter on