From 623522c5b880d29b832bee06e0a4b0a3b80269bd Mon Sep 17 00:00:00 2001 From: Bousquin Date: Mon, 11 Sep 2023 21:38:17 -0500 Subject: [PATCH] Added example to class --- harmonize_wq/harmonize.py | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/harmonize_wq/harmonize.py b/harmonize_wq/harmonize.py index c245656..d93a665 100644 --- a/harmonize_wq/harmonize.py +++ b/harmonize_wq/harmonize.py @@ -45,7 +45,31 @@ class WQCharData(): Examples -------- + Build dataframe to use as input: + >>> import pandas + >>> from numpy import nan + >>> df = pandas.DataFrame({'CharacteristicName': ['Phosphorus', + 'Temperature, water',], + ... 'ResultMeasure/MeasureUnitCode': [nan, nan], + ... 'ResultMeasureValue': ['1.0', '10.0',], + ... }) + >>> df + CharacteristicName ResultMeasure/MeasureUnitCode ResultMeasureValue + 0 Phosphorus NaN 1.0 + 1 Temperature, water NaN 10.0 + + >>> wq = harmonize.WQCharData(df, 'Phosphorus') + >>> wq.df + CharacteristicName ResultMeasure/MeasureUnitCode ... Units Phosphorus + 0 Phosphorus NaN ... NaN 1.0 + 1 Temperature, water NaN ... NaN NaN + + [2 rows x 5 columns] + >>> wq.df.columns + Index(['CharacteristicName', 'ResultMeasure/MeasureUnitCode', + 'ResultMeasureValue', 'Units', 'Phosphorus'], + dtype='object') """ def __init__(self, df_in, char_val):