Skip to content

Commit be19886

Browse files
committed
update fit docs
1 parent 24d57f7 commit be19886

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

lib/gnuplotrb/fit.rb

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
module GnuplotRB
22
##
33
# ====== Overview
4-
# Fit given data with function. Covered in {fit notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/fitting_data.ipynb].
4+
# Fit given data with function. Covered in
5+
# {fit notebook}[http://nbviewer.ipython.org/github/dilcom/gnuplotrb/blob/master/notebooks/fitting_data.ipynb].
56
# ====== Arguments
67
# * *data* - method accepts the same sources as Dataset.new
78
# and Dataset object
89
# * *:function* - function to fit data with. Default 'a2*x*x+a1*x+a0'
910
# * *:initials* - initial values for coefficients used in fitting.
1011
# Default: {a2: 1, a1: 1, a0: 1}
11-
# * *:via* - coefficients that Gnuplot should change during fitting.
12-
# Default: initials#keys
1312
# * *:term_options* - terminal options that should be setted to terminal before fit.
14-
# For example *xrange*, *yrange* etc
15-
# * *options* - options passed to Gnuplot's fit such as *using*
13+
# You can see them in Plot's documentation (or even better in gnuplot doc).
14+
# Most useful here are ranges (xrange, yrange etc) and fit option which tunes fit parameters
15+
# (see {gnuplot doc}[http://www.gnuplot.info/docs_5.0/gnuplot.pdf] p. 122).
16+
# * *options* - options passed to Gnuplot's fit such as *using*. They are covered in
17+
# {gnuplot doc}[http://www.gnuplot.info/docs_5.0/gnuplot.pdf](pp. 69-74)
1618
# ====== Return value
1719
# Fit returns hash of 4 elements:
1820
# * *:formula_ds* - dataset with best fit curve as data

0 commit comments

Comments
 (0)