Skip to content

Commit b200de8

Browse files
committed
update docs
1 parent a63c172 commit b200de8

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Ethopy Analysis provides a modern, modular approach to behavioral data analysis
1616

1717
- **DataFrame-based**: Most of plotting functions work with pandas DataFrames, making them independent of data source
1818
- **Modular Design**: Composable functions for different analysis levels (animal, session, comparison)
19-
- **Database Agnostic**: Works with DataJoint databases, CSV files, or any pandas-compatible data source
20-
- **Extensible**: Plugin system for custom plots and analysis functions
19+
- **DataJoint-based**: Works with DataJoint databases and provides DataFrame interfaces
20+
- **Extensible**: Modular function-based architecture for easy extension
2121
- **Production Ready**: Command-line interface, proper packaging, and configuration management
2222

2323
## Installation
@@ -64,7 +64,7 @@ ethopy-analysis/
6464
│ │ ├── animal.py # Animal-level plots
6565
│ │ ├── session.py # Session-level plots
6666
│ │ ├── comparison.py # Multi-animal/condition comparisons
67-
│ │ └── utils.py # Plotting utilities and plugin system
67+
│ │ └── utils.py # Plotting utilities
6868
│ ├── db/ # Database connectivity
6969
│ │ ├── schemas.py # Database schema management
7070
│ │ └── utils.py # Database utility functions

docs/developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ src/ethopy_analysis/
101101

102102
**1. DataFrame-First**
103103
- All functions work with pandas DataFrames
104-
- Database-agnostic design
104+
- DataJoint-based data loading with DataFrame interfaces
105105
- Easy testing and debugging
106106

107107
**2. Function-Based**

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Ethopy Analysis provides a modern, modular approach to behavioral data analysis
1010

1111
- **DataFrame-based**: Plotting functions work with pandas DataFrames
1212
- **Modular Design**: Composable functions for different analysis levels (animal, session, comparison)
13-
- **Database Agnostic**: Works with DataJoint databases, CSV files, or any pandas-compatible data source
14-
- **Extensible**: Plugin system for custom plots and analysis functions
13+
- **DataJoint-based**: Works with DataJoint databases and provides DataFrame interfaces
14+
- **Extensible**: Modular function-based architecture for easy extension
1515
- **Production Ready**: Command-line interface, proper packaging, and configuration management
1616

1717
## Quick Links
@@ -27,7 +27,7 @@ Ethopy Analysis provides a modern, modular approach to behavioral data analysis
2727
The package is organized into focused modules:
2828

2929
- **`data/`** - Data loading and processing functions
30-
- **`plots/`** - Plotting functions (DataFrame-based, database-agnostic)
30+
- **`plots/`** - Plotting functions (DataFrame-based, DataJoint-sourced)
3131
- **`db/`** - Database connectivity
3232
- **`config/`** - Configuration management
3333
- **`cli.py`** - Command-line interface

0 commit comments

Comments
 (0)