Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JOSS Paper content #37

Merged
merged 42 commits into from
May 20, 2024
Merged
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
c35c3e9
try with suggested job and .Rmd format
j-i-l Mar 18, 2024
7cd4ece
follow suggeston for output
j-i-l Mar 18, 2024
ea6ac3c
use normal .md for paper
j-i-l Mar 18, 2024
eb8722b
noT: Merge branch 'main' into JOSSpaper
j-i-l Mar 18, 2024
e08461c
noT; actual .md file
j-i-l Mar 18, 2024
924759f
noT; path from root
j-i-l Mar 18, 2024
a52e3d3
noT: minor formatting
j-i-l Mar 18, 2024
d17a225
noT; fixing missing closing statement
j-i-l Mar 18, 2024
83d3b78
noT; ok - now in the right file
j-i-l Mar 18, 2024
c60d9ac
noT; with hyperlink
j-i-l Mar 18, 2024
97e8cac
noT; with hyperlink - 2nd try
j-i-l Mar 18, 2024
d89a2c1
noT; no hyperlink - keep it simple
j-i-l Mar 18, 2024
0b63a0d
coverage check after successful CRAN check. Closing #23.
matteodelucchi Mar 19, 2024
2285596
noT; removing seperated coverage workflow. Relates to #23.
matteodelucchi Mar 20, 2024
59f7ffd
start to publish releases (#35)
j-i-l Mar 20, 2024
7f2e2e5
typo
j-i-l Mar 20, 2024
edfac00
closes #20; branch implements paper creation
j-i-l Mar 20, 2024
0aa7891
Merge branch 'main' into JOSSpaper_noT
j-i-l Mar 24, 2024
c433c83
using proper nouns for abbreviated terms
j-i-l Mar 25, 2024
129db65
updated date to new planned submission date.
matteodelucchi Mar 26, 2024
84d5f91
Revised text according co-authors feedback. Addressing #47
matteodelucchi Mar 26, 2024
9d4d8b9
suggest: rephrasing of shortcomings
j-i-l Mar 26, 2024
8ec2659
Merge branch 'JOSSpaper_noT' of github.com:furrer-lab/abn into JOSSpa…
j-i-l Mar 26, 2024
5eb1538
more rephrasing. Addressing #47.
matteodelucchi Mar 26, 2024
d7dd8b2
typos in affiliation etc.
matteodelucchi Mar 26, 2024
7baa42b
removing the Rmd as we only need the md
matteodelucchi Mar 26, 2024
5c3fd4b
Merge pull request #49 from furrer-lab/main
matteodelucchi Mar 26, 2024
024a5d2
clarified the target audience. Addressing #33
matteodelucchi Apr 5, 2024
210c47b
Merge branch 'JOSSpaper_noT' of github.com:furrer-lab/abn into JOSSpa…
matteodelucchi Apr 5, 2024
06c7697
Specified PhD supervisors. Addressing #47
matteodelucchi Apr 10, 2024
db2b3bc
Update paper.md
reinhardfurrer Apr 16, 2024
37b781e
Incorporated Reinhard's feedback. Addressing #47
matteodelucchi Apr 17, 2024
cacec05
Merge branch 'main' into JOSSpaper_noT
matteodelucchi May 8, 2024
c9cb666
added Georg to the list of authors.
matteodelucchi May 14, 2024
83865b4
Changed focus of repo source.
matteodelucchi May 14, 2024
94a7d4a
Added note regarding CRAN availability.
matteodelucchi May 14, 2024
203af34
Update README.md
reinhardfurrer May 14, 2024
1ee3db4
Update paper.md
reinhardfurrer May 14, 2024
83a9bad
improved formulation. Addressing #47
matteodelucchi May 15, 2024
7abdf71
updated funding statement. Addressing #47
matteodelucchi May 20, 2024
7ef8208
building JOSS paper also on main
j-i-l May 20, 2024
71061ba
Merge branch 'main' into JOSSpaper_noT
j-i-l May 20, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions vignettes/paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,20 +37,24 @@ BNs are a type of statistical model that leverages the principles of Bayesian st
ABN models extend the concept of generalized linear models, typically used for predicting a single outcome, to scenarios with multiple dependent variables (e.g. @kratzer_additive_2023).
This makes them a powerful tool for understanding complex, multivariate datasets.

[//]: # (You switch from BN to ABN 1st paragraph, then revisit BN and again to ABN. First all BN then To ABN.)
matteodelucchi marked this conversation as resolved.
Show resolved Hide resolved

# Statment of need
The increasing complexity of data in various fields, ranging from healthcare research to environmental science and ecology, has resulted in a need for a tool like `abn`.
Researchers often face multivariate, tabular data where the relationships between variables are not straightforward.
BN analysis becomes essential when traditional statistical methods fall short in analyzing multivariate data with intricate relationships, as it models these relationships graphically for more straightforward data interpretation.
BN analysis becomes essential when traditional statistical methods fail to analyze multivariate data with intricate relationships, as it models these relationships graphically for more straightforward data interpretation.

Commonly used implementations of BN models, such as `bnlearn` [@bnlearn2010], `bnstruct` [@franzin_bnstruct_2017], `deal` [@boettcher_deal_2003], `gRain` [@hojsgaard_graphical_2012], `pcalg` [@kalisch_causal_2012] and `pchc` [@tsagris_new_2021], limit variable types, often allowing discrete variables to have only discrete parent variables, where a parent starts a directed edge in the graph.
This limitation can pose challenges when dealing with continuous or mixed-type data (i.e., data that includes both continuous and discrete variables) or when attempting to model complex relationships that do not fit these restricted categories.
For a comprehensive overview of structure learning algorithms, including those applicable to mixed-type data, we refer the reader to the works of @kitson_survey_2023 and @zanga_survey_2022.
In the context of patient data, the study from @delucchi_bayesian_2022 has discussed further details and strategies for handling this scenario, particularly in relation to the `abn` package and the widely used `bnlearn` package [@bnlearn2010].

[//]: # (Next line you talk about `these limitations`. Suboptimal, ascendant not clear. Especially in the previous paragraph you only talk about `this limitation`.)
matteodelucchi marked this conversation as resolved.
Show resolved Hide resolved

The `abn` package overcomes these limitations through its additive model formulation, which generalizes the usual (Bayesian) multivariable regression to accommodate multiple dependent variables.
Additionally, the `abn` package offers a comprehensive suite of features for model selection, structure learning, and parameter estimation.
It includes exact and greedy search algorithms for structure learning and allows for integrating prior expert knowledge into the model selection process by specifying structural constraints.
For model selection, a Bayesian and an information-theoretic model scoring approach are available, allowing users to choose between a Bayesian and frequentist paradigm.
A Bayesian and an information-theoretic model scoring approach are available for model selection, allowing users to choose between a Bayesian and frequentist paradigm.
To our knowledge, this feature is not available in other software.
Furthermore, it supports mixed-effect models to control one-layer clustering, making it suitable, e.g., for handling data from different sources.

Expand All @@ -69,7 +73,9 @@ Its unique contribution is the implementation of mixed-effect BN models, thereby
# Implementation
As outlined in @kratzer_additive_2023, the package's comprehensive framework integrates the mixed-effects model for clustered data, considering data heterogeneity and grouping effects.
However, this was confined to a Bayesian context.
With the release of `abn` major version 3 this was completed with an implementation under the informaiton-theoretic ("mle") setting.
With the release of `abn` major version 3, this was completed with an implementation under the information-theoretic ("mle") setting.

[//]: # (Maybe frame in line 74: more as there existed a first attempt towards mixed-effects in a Bayesian fitting context. or even a bit weaker.)
matteodelucchi marked this conversation as resolved.
Show resolved Hide resolved

Analyzing hierarchical or grouped data, i.e., observations nested within higher-level units, requires statistical models with group-varying parameters (e.g., mixed-effect models).
The `abn` package facilitates single-layer clustering, where observations are grouped.
Expand All @@ -83,6 +89,8 @@ Currently, only single-layer clustering is supported (e.g., for `method = "mle"`
With a Bayesian approach (`method = "bayes"`), `abn` utilizes its own implementation of the Laplace approximation as well as the `INLA` package [@inla2013] to fit a single-level hierarchical model for Binomial, Poisson, and Gaussian distributed variables.
Independent of the type of data, multinomial distributed variables are not yet implemented with `method ="bayes"` (details in the [online manual](https://r-bayesian-networks.org/quick_start_example.html)).

[//]: # (Line 90 needed?)
matteodelucchi marked this conversation as resolved.
Show resolved Hide resolved

Furthermore, the code base has been enhanced to be more efficient, reliable, and user-friendly through code optimization, regular reviews and continuous integration practices.
We have adhered to the latest open-source software standards, including active maintenance of `abn`.
Future updates to augment its functionality are planned via a flexible roadmap.
Expand All @@ -109,13 +117,16 @@ The development version of the `abn` package is hosted on [GitHub](https://githu
devtools::install_github("furrer-lab/abn")
```

[//]: # (Comment should be above, do you mention that this is all under `R`??)
matteodelucchi marked this conversation as resolved.
Show resolved Hide resolved


# Acknowledgments

The development of the `abn` package would not have been possible without the significant contributions of the former developers whose efforts have been instrumental in shaping this project.
We acknowledge the contributions of Fraser Iain Lewis, Marta Pittavino, Gilles Kratzer, and Kalina Cherneva, in particular.
We want to extend our gratitude to the faculty staff at the [Department of Mathematical Modeling and Machine Learning from the University of Zurich](https://dm3l.uzh.ch/home) and the [Institute of Mathematics](https://www.math.uzh.ch/home) who maintain the research and teaching infrastructure.
Our appreciation also goes to the UZH and the ZHAW for their financial support.
We would like to highlight the funding from the Digitalization Initiative of the Zurich Higher Education Institutions (DIZH), which was instrumental in the realization of this project, particularly within the context of the "Modeling of multicentric and dynamic stroke health data" and "Stroke DynamiX" projects.
We want to highlight the funding from the Digitalization Initiative of the Zurich Higher Education Institutions (DIZH), which was instrumental in the realization of this project, particularly within the context of the "Modeling of multicentric and dynamic stroke health data" and "Stroke DynamiX" projects.
This work has been conducted as part of M.D.'s PhD project, which is co-supervised by Prof. Dr. Sven Hirsch (ZHAW) and Prof. Dr. Reinhard Furrer (UZH).

# References