search

cjekel / piecewise_linear_fit_py

fit piecewise linear data for a specified number of line segments
MIT License
289 stars 59 forks source link

write paper describing all mathematical methods used in library #12

Closed cjekel closed 5 years ago

cjekel commented 5 years ago

This Library has grown significantly since it's inception. I've included statistical features that have not been formally written (standard errors and prediction variance).

Before I fall behind, I need to write a paper describing all of the features and use cases of this library. This will need to describe the underlining mathematics and statistics the library follows.

SebastianHD commented 5 years ago

For now, what is the best way to reference your work?

cjekel commented 5 years ago

Thank you for wanting to cite this work.

You can cite my work as 

@Manual{pwlf,
    author = {Jekel, Charles F. and Venter, Gerhard},
    title = {{pwlf:} A Python Library for Fitting 1D Continuous Piecewise Linear Functions},
    year = {2019},
    url = {https://github.com/cjekel/piecewise_linear_fit_py}
}

Which will look something like the following when formatted.

C. F. Jekel and G. Venter, pwlf: A Python Library for Fitting 1D Continuous Piecewise Linear Functions, 2019. [Online]. Available: https://github.com/cjekel/piecewise_linear_fit_py

I've uploaded a draft version of the manuscript in the paper folder. You can download it here.

It will take a very long time before a peer reviewed manuscript comes out.

cjekel commented 5 years ago

Newer version of the paper is out. You can download the paper here.