Skip to content

Commit 2715dba

Browse files
author
cpdmulde
committed
adjust usage file
1 parent 4fcb562 commit 2715dba

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

_sources/usage.rst.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ As the package was developed with the help of Jupyter Notebook (version 4.4.1) a
1010

1111
Once the package is imported, the suggested workflow is as follows:
1212

13-
1. Read data and convert it to a pandas DataFrame (see [the pandas documentation](https://pandas.pydata.org) for more information); format it in the way you like.
13+
1. Read data and convert it to a pandas DataFrame (see (the pandas documentation)[https://pandas.pydata.org) for more information]; format it in the way you like.
1414

1515
2. Create an object of any of the three classes in the wwdata package, e.g. the OnlineSensorBased class::
1616

@@ -21,14 +21,12 @@ Once the package is imported, the suggested workflow is as follows:
2121
data.to_datetime(time_column="time",time_format="%dd-%mm-%yy")
2222
data.get_avg()
2323

24-
4. Tag non-valid data points. The way to do this depends on the data you are working with, but the general approach would be::
24+
4. Tag non-valid data points. The way to do this depends on the data you are working with, but the general approach would be to simply apply any of the filtering functions to the class object::
2525

2626
data.tag_nan()
2727
data.moving_slope_filter(xdata="time",data_name="series1",cutoff=3,arange=['1/1/2017','1/2/2017'])
2828

29-
i.e. to simply apply any of the filtering functions to the class object.
30-
31-
5. Apply any other functionalities to the object. In the below example, this is the filling of the gaps introduced by filtering data in the previous step (for details on the meaning of the arguments, please refer to the documentation provided within the source code)::
29+
5. Apply any other functionalities to the object. In the below example, this is the filling of the gaps introduced by filtering data in the previous step (for details on the meaning of the arguments, please refer to the specific documentation provided)::
3230

3331
data.fill_missing_interpolation("series1",range_=12,arange=['1/1/2017','1/2/2017'])
3432
data.fill_missing_model("series1","model_data_series",arange=['1/1/2017','1/2/2017'])

0 commit comments

Comments
 (0)