Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update summary for readme #26

Merged
merged 2 commits into from
Jan 23, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,25 @@ $ pip install pyeda
from pyeda.check_csv import check_csv
from pyeda.pymissing_values_summary import missing_values_summary
from pyeda.data_summary import get_summary_statistics

# Check if the given data file is in csv format
```
#### Check if the given data file is in csv format
```python
data_file_path = "docs/sample_data.csv" # path to your data file
if not check_csv(data_file_path):
raise TypeError("The given file is not in CSV format. Please check your data file.")

# Check if the data file has any missing values
```
#### Check if the data file has any missing values
```python
df = pd.read_csv(data_file_path)

missing_summary = missing_values_summary(df)
print("Missing Values Summary:")
print(missing_summary)


# Get data summary
```
#### Get the data summary for either all columns or the specified columns of our dataset
```python
get_summary_statistics(df)
get_summary_statistics(df, col=["numeric", "categorical"])
```

## Contributing
Expand Down
Loading