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

refactor: fix typos #170

Merged
merged 1 commit into from
Oct 9, 2023
Merged
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion edvart/data_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def is_numeric(series: pd.Series) -> bool:
"""
if is_missing(series):
return False
# When an unkown dtype is encountered, `np.issubdtype(series.dtype, np.number)`
# When an unknown dtype is encountered, `np.issubdtype(series.dtype, np.number)`
# raises a TypeError. This happens for example if `series` is `pd.Categorical`
# If the dtype is unknown, we treat it as non-numeric, therefore return False.
try:
Expand Down
8 changes: 4 additions & 4 deletions edvart/report.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ def _generate_notebook(
dataset_name : str (default = "[INSERT DATASET NAME]")
Name of dataset to be used in the title of the report.
dataset_description : str (default = "[INSERT DATASET DESCRIPTION]")
Descritpion of dataset to be used below the title of the report.
Description of dataset to be used below the title of the report.
load_df : str (default = 'df = ...')
Code string for loading a dataset to variable `df`.
extra_imports : List[str], optional
Expand Down Expand Up @@ -617,7 +617,7 @@ class DefaultReport(Report):
Verbosity of the overview section
verbosity_univariate_analysis : Verbosity, optional
Verbosity of the univariate analysis section
verbosity_bivariate_analysis : Verbosity, optiona
verbosity_bivariate_analysis : Verbosity, optional
Verbosity of the bivariate analysis section.
verbosity_multivariate_analysis: Verbosity, optional
Verbosity of the multivariate analysis section
Expand Down Expand Up @@ -833,10 +833,10 @@ class DefaultTimeseriesReport(TimeseriesReport):
sampling_rate : int, optional
Sampling rate for Fourier transform and Short-time Fourier transform subsections. Determines
frequency unit for analysis of frequencies, for example with monthly data and sampling rate
12, yearly frequncy spectrum is produced.
12, yearly frequency spectrum is produced.
If not set, these two sections will not be included.
stft_window_size : int, optional
Windows size for short-time Fourier transform subsection. If not set, STFT will be exluded.
Windows size for short-time Fourier transform subsection. If not set, STFT will be excluded.
"""

def __init__(
Expand Down
2 changes: 1 addition & 1 deletion edvart/report_sections/bivariate_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -992,7 +992,7 @@ def contingency_table(
ax.set_xlabel(ax.get_xlabel(), fontsize=fontsize)
ax.xaxis.set_label_position("top")

# Viusally separate the margins
# Visually separate the margins
if include_total:
ax.vlines(len(table.columns) - 1, ymin=0, ymax=len(table), color="grey")
ax.hlines(len(table) - 1, xmin=0, xmax=len(table.columns), color="grey")
Expand Down
6 changes: 3 additions & 3 deletions edvart/report_sections/dataset_overview.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ class Overview(ReportSection):
Parameters
----------
subsections : List[OverviewSubsection], optional
List of subsections to inlcude into the Overview section.
List of subsections to include into the Overview section.
All subsections in OverviewSubsection are used by default.
verbosity : Verbosity
Generated code verbosity global to the Overview sections
Expand Down Expand Up @@ -925,7 +925,7 @@ def missing_value_row_count(df: pd.DataFrame, columns: Optional[List[str]] = Non
Parameters
----------
df : pd.DataFrame
Dataframe for which to counnt missing value rows.
Dataframe for which to count missing value rows.
columns : Optional[List[str]], optional
List of columns to consider when counting. If None, all columns are used.
"""
Expand Down Expand Up @@ -1029,7 +1029,7 @@ def duplicate_row_count(df: pd.DataFrame, columns: Optional[List[str]] = None) -
Parameters
----------
df : pd.DataFrame
Dataframe for which to counnt missing value rows.
Dataframe for which to count missing value rows.
columns : Optional[List[str]], optional
List of columns to consider when counting. If None, all columns are used.
"""
Expand Down
2 changes: 1 addition & 1 deletion edvart/report_sections/group_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ def group_barplot(
Maximum number of unique values in column to plot. If the number of unique values
is higher, a warning will be issued and plot will not be shown.
conditional_probability : bool (default = True)
If True, conditional probability contitioned on group will be displayed,
If True, conditional probability conditioned on group will be displayed,
otherwise conditional frequency will be displayed.
xaxis_tickangle : float (default = 0)
Rotation angle of ticks on the x axis.
Expand Down
2 changes: 1 addition & 1 deletion edvart/report_sections/multivariate_analysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ def show_multivariate_analysis(
All numeric columns are used by default.
color_col : str, optional
Name of the column according to which to color points in the sections.
Both numberic and categorical columns are supported.
Both numeric and categorical columns are supported.
"""
if columns is not None:
df = df[columns]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ def show_rolling_statistics(
Multiple of standard deviation from mean to show bands at.
Ignored if not showing bands.
show_std_dev : bool (default = True)
Whether to plot rolling standard devation.
Whether to plot rolling standard deviation.
color_mean : str (default = "#2040FF")
Color of the line showing rolling mean.
color_band : str (default = "#90E0FF")
Expand Down