Skip to content

Commit

Permalink
Fix doc warnings.
Browse files Browse the repository at this point in the history
  • Loading branch information
vnmabus committed Apr 4, 2023
1 parent 2f09844 commit b158452
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 15 deletions.
19 changes: 19 additions & 0 deletions docs/refs.bib
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,25 @@ @article{pini++_2018_hotelling
keywords = {Functional data,High-dimensional data Hotelling’s,Hilbert space,Nonparametric inference,Permutation test}
}

@inbook{ramsay+silverman_2005_functionala,
title = {From Functional Data to Smooth Functions},
booktitle = {Functional Data Analysis},
author = {Ramsay, James and Silverman, B. W.},
year = {2005},
series = {Springer {{Series}} in {{Statistics}}},
edition = {Second},
pages = {37--58},
publisher = {{Springer-Verlag}},
address = {{New York}},
doi = {10.1007/b98888},
url = {https://www.springer.com/gp/book/9780387400808},
urldate = {2021-09-19},
collaborator = {Ramsay, James and Silverman, B. W.},
isbn = {978-0-387-40080-8},
langid = {english},
keywords = {Multivariate analysis}
}

@inbook{ramsay+silverman_2005_registration,
title = {The Registration and Display of Functional Data},
booktitle = {Functional Data Analysis},
Expand Down
8 changes: 3 additions & 5 deletions examples/plot_oneway.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@
# The function returns first the statistic :func:`~skfda.inference.anova
# .v_sample_stat` used to measure the variability between groups,
# second the *p-value* of the test . For further information visit
# :func:`~skfda.inference.anova.oneway_anova` and [1].
# :func:`~skfda.inference.anova.oneway_anova` and
# :footcite:t:`cuevas++_2004_anova`.

print('Statistic: ', v_n)
print('p-value: ', p_val)
Expand Down Expand Up @@ -111,7 +112,4 @@

###############################################################################
# **References:**
#
# [1] Antonio Cuevas, Manuel Febrero-Bande, and Ricardo Fraiman. "An anova
# test for functional data". *Computational Statistics Data Analysis*,
# 47:111-112, 02 2004
# .. footbibliography::
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ rst-directives =
versionadded,versionchanged,

rst-roles =
attr,class,doc,footcite,footcite:ts,func,meth,mod,obj,ref,term,external:class
attr,class,doc,footcite,footcite:p,footcite:t,footcite:ps,footcite:ts,func,meth,mod,obj,ref,term,external:class

allowed-domain-names = data, obj, result, results, val, value, values, var

Expand Down
2 changes: 2 additions & 0 deletions skfda/representation/_functional_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -1170,12 +1170,14 @@ def take( # noqa: WPS238
Parameters:
indices: Indices to be taken.
allow_fill: How to handle negative values in `indices`.
* False: negative values in `indices` indicate positional
indices from the right (the default). This is similar to
:func:`numpy.take`.
* True: negative values in `indices` indicate
missing values. These values are set to `fill_value`. Any
other negative values raise a ``ValueError``.
fill_value: Fill value to use for NA-indices
when `allow_fill` is True.
This may be ``None``, in which case the default NA value for
Expand Down
17 changes: 8 additions & 9 deletions skfda/representation/basis/_bspline_basis.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,9 @@ class BSplineBasis(Basis):
Implementation details: In order to allow a discontinuous behaviour at
the boundaries of the domain it is necessary to placing m knots at the
boundaries [RS05]_. This is automatically done so that the user only has to
specify a single knot at the boundaries.
boundaries\ :footcite:p:`ramsay+silverman_2005_functionala`. This is
automatically done so that the user only has to specify a single knot
at the boundaries.
Parameters:
domain_range: A tuple of length 2 containing the initial and
Expand Down Expand Up @@ -85,8 +86,7 @@ class BSplineBasis(Basis):
[ 2.]]])
References:
.. [RS05] Ramsay, J., Silverman, B. W. (2005). *Functional Data
Analysis*. Springer. 50-51.
.. footbibliography::
"""

Expand Down Expand Up @@ -391,9 +391,9 @@ class BSpline(BSplineBasis):
Implementation details: In order to allow a discontinuous behaviour at
the boundaries of the domain it is necessary to placing m knots at the
boundaries [RS05]_. This is automatically done so that the user only has to
specify a single knot at the boundaries.
boundaries\ :footcite:p:`ramsay+silverman_2005_functionala`. This is
automatically done so that the user only has to specify a single knot
at the boundaries.
Parameters:
domain_range: A tuple of length 2 containing the initial and
Expand Down Expand Up @@ -446,8 +446,7 @@ class BSpline(BSplineBasis):
[ 2.]]])
References:
.. [RS05] Ramsay, J., Silverman, B. W. (2005). *Functional Data
Analysis*. Springer. 50-51.
.. footbibliography::
"""

Expand Down

0 comments on commit b158452

Please sign in to comment.