Skip to content

Commit

Permalink
readme update and docstring update
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhengHe-007 committed Jan 23, 2025
1 parent b2f0279 commit 9187c8d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,17 @@ 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
data_file_path = "data.csv" # path to your data file
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
df = pd.read_csv(data_file_path)

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


# Get data summary
```
Expand Down
1 change: 1 addition & 0 deletions src/pyeda/pymissing_values_summary.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ def missing_values_summary(df):
Examples
--------
>>> from pyeda.pymissing_value import missing_values_summary
>>> missing_values_summary(df)
"""
# Calculate the count of missing values for each column
Expand Down

0 comments on commit 9187c8d

Please sign in to comment.