Skip to content

Commit

Permalink
add paragraph in core ideas
Browse files Browse the repository at this point in the history
  • Loading branch information
zhengp0 committed Apr 8, 2024
1 parent f1dd600 commit 32290bf
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ bibliography: paper.bib

---

# `xspline`: A Python Package for Flexible Spline Modeling

Check notice on line 34 in paper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

paper.md#L34

Multiple top-level headings in the same document

Check notice on line 34 in paper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

paper.md#L34

Multiple top-level headings in the same document

## Summary

Splines are a fundamental tool for describing and estimating nonlinear relationships [@de1978practical]. They allow nonlinear functions to be represented as linear combinations of spline basis elements. Researchers in physical, biological, and health sciences rely on spline models in conjunction with statistical software packages to fit and describe a vast range of nonlinear relationships.
Expand Down Expand Up @@ -62,7 +64,26 @@ This functionality is essential to risk modeling. For example, data reported by

## Core idea and structure of `xspline`

- Peng to write
The main idea of `xspline` is to provide a python class that allows user to
interact with basis splines, their derivatives and integrals and extrapolation
options more easily.

The computation of splines is based on B-spline or basis spline from

Check notice on line 71 in paper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

paper.md#L71

Multiple top-level headings in the same document
[@de1978practical]. Upon this, we derived the derivatives and definite integrals
from the recursive relationship between the splines.

To support the spline basis computation, we also created modules that provide

Check notice on line 75 in paper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

paper.md#L75

Multiple top-level headings in the same document
convenient interface with indicator and polynomial function and their arbitrary
order of derivatives and definite integrals. We boundle all those useful
functions into a main interface class called `XFunction` which allow user call
the function with specified order, where positive order represent derivatives
and negative order represent definite integrals.

At end very end, we allow user to specify the way they want to extrapolate by
matching the smoothness at the end knots.

With all of the above features, we created a easy to use and very useful spline
package for statistical model building. For more examples please check [here](https://ihmeuw-msca.github.io/xspline/quickstart.html).

More information about the structure of the library can be found in [documentation](https://ihmeuw-msca.github.io/xspline/api_reference/),
while the mathematical use cases are extensively discussed in [@zheng2021trimmed] and [@zheng2022burden] in the context of fitting risks.
Expand Down

0 comments on commit 32290bf

Please sign in to comment.