Skip to content

Commit dfab911

Browse files
committed
Add reference to new JSS article
1 parent b126bfa commit dfab911

16 files changed

+38
-10
lines changed

Diff for: DESCRIPTION

+4-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ Description: Find the permutation symmetry group such that the covariance
1616
the covariance matrix found with 'gips' approximates the actual
1717
covariance with less statistical error. The methods implemented in
1818
this package are described in Graczyk et al. (2022)
19-
<doi:10.1214/22-AOS2174>.
19+
<doi:10.1214/22-AOS2174>. Documentation about 'gips' is
20+
provided via its website at <https://przechoj.github.io/gips/> and
21+
the paper by Chojecki, Morgen, Kołodziejek
22+
(2025, <doi:10.18637/jss.v112.i07>).
2023
License: GPL (>= 3)
2124
URL: https://github.com/PrzeChoj/gips, https://przechoj.github.io/gips/
2225
BugReports: https://github.com/PrzeChoj/gips/issues

Diff for: R/gips_class.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
#' For analysis of the Hyperparameters influence, see **Section 3.2.**
6969
#' of "Learning permutation symmetries with gips in R"
7070
#' by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek,
71-
#' available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
71+
#' [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).
7272
#'
7373
#' @returns `gips()` returns an object of
7474
#' a `gips` class after the safety checks.

Diff for: README.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Note that the rank of the `S` matrix was 4, while the rank of the `S_projected`
228228

229229
For more examples and introduction, see `vignette("gips", package="gips")` or its [pkgdown page](https://przechoj.github.io/gips/articles/gips.html).
230230

231-
For an in-depth analysis of the package performance, capabilities, and comparison with similar packages, see the article "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
231+
For an in-depth analysis of the package performance, capabilities, and comparison with similar packages, see the article "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).
232232

233233

234234
# Acknowledgment

Diff for: README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -266,8 +266,8 @@ page](https://przechoj.github.io/gips/articles/gips.html).
266266
For an in-depth analysis of the package performance, capabilities, and
267267
comparison with similar packages, see the article “Learning permutation
268268
symmetries with gips in R” by `gips` developers Adam Chojecki, Paweł
269-
Morgen, and Bartosz Kołodziejek, available on
270-
[arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
269+
Morgen, and Bartosz Kołodziejek, [Journal of Statistical
270+
Software](https://doi.org/10.18637/jss.v112.i07).
271271

272272
# Acknowledgment
273273

Diff for: cran-comments.md

+5
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,8 @@ Testing with `devtools::check_rhub()` - no Errors, no Warnings, only technical N
1414
0 errors | 0 warnings | 0 notes
1515

1616
R CMD check succeeded
17+
18+
19+
## Citation Information
20+
21+
The DOI in the CITATION is for a new JSS publication that will be registered after publication on CRAN.

Diff for: inst/CITATION

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
bibentry(bibtype = "Article",
2+
title = "Learning Permutation Symmetry of a {G}aussian Vector with {gips} in {R}",
3+
author = c(person(given = "Adam",
4+
family = "Chojecki",
5+
email = "[email protected]"),
6+
person(given = "Pawe{\\l}",
7+
family = "Morgen",
8+
email = "[email protected]"),
9+
person(given = "Bartosz",
10+
family = "Ko{\\l}odziejek",
11+
email = "[email protected]")),
12+
journal = "Journal of Statistical Software",
13+
year = "2025",
14+
volume = "112",
15+
number = "7",
16+
pages = "1--38",
17+
doi = "10.18637/jss.v112.i07",
18+
header = "To cite gips in publications use:"
19+
)

Diff for: inst/WORDLIST

+1
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ frac
5252
ge
5353
iter
5454
iteratively
55+
jss
5556
ldots
5657
le
5758
mapsto

Diff for: man/figures/README-example_mean_known1_1-1.png

-78 Bytes
Loading

Diff for: man/figures/README-example_mean_known3_1-1.png

2 Bytes
Loading

Diff for: man/figures/README-example_mean_known6-1.png

-35 Bytes
Loading

Diff for: man/figures/README-example_mean_unknown2-1.png

-6 Bytes
Loading

Diff for: man/figures/README-example_mean_unknown4-1.png

-25 Bytes
Loading

Diff for: man/gips.Rd

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: vignettes/Optimizers.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ We encourage everyone to discuss on available and potential new optimizers on [I
367367

368368
[1] Piotr Graczyk, Hideyuki Ishi, Bartosz Kołodziejek, Hélène Massam. "Model selection in the space of Gaussian models invariant by symmetry." The Annals of Statistics, 50(3) 1747-1774 June 2022. [arXiv link](https://arxiv.org/abs/2004.03503); [DOI: 10.1214/22-AOS2174](https://doi.org/10.1214/22-AOS2174)
369369

370-
[2] "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
370+
[2] "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).
371371

372372
```{r options_back, include = FALSE}
373373
options(old_options) # back to the original options

Diff for: vignettes/Theory.Rmd

+1-1
Original file line numberDiff line numberDiff line change
@@ -406,4 +406,4 @@ We will consider a `g_map` better model both in terms of the AIC and the BIC.
406406

407407
[1] Piotr Graczyk, Hideyuki Ishi, Bartosz Kołodziejek, Hélène Massam. "Model selection in the space of Gaussian models invariant by symmetry." The Annals of Statistics, 50(3) 1747-1774 June 2022. [arXiv link](https://arxiv.org/abs/2004.03503); [DOI: 10.1214/22-AOS2174](https://doi.org/10.1214/22-AOS2174)
408408

409-
[2] "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
409+
[2] "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).

Diff for: vignettes/gips.Rmd

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ We propose creating a set of constraints on the covariance matrix to use the max
5858

5959
This package provides a way to find a *reasonable* permutation to be used as a constraint in covariance matrix estimation. In this case, *reasonable* means maximizing the Bayesian posterior distribution when using a Wishart-like distribution on symmetric, positive definite matrices as a prior. The idea, exact formulas, and algorithm sketch are explored in another vignette that can be accessed by `vignette("Theory", package="gips")` or on its [pkgdown page](https://przechoj.github.io/gips/articles/Theory.html).
6060

61-
For an in-depth analysis of the package performance, capabilities, and comparison with other packages, see the article "Learning permutation symmetries with gips in R" by `gips`' developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
61+
For an in-depth analysis of the package performance, capabilities, and comparison with other packages, see the article "Learning permutation symmetries with gips in R" by `gips`' developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).
6262

6363

6464
# Practical example
@@ -239,7 +239,7 @@ Now, the estimated covariance matrix is of full rank (5).
239239

240240
1. To learn more about the available optimizers in `find_MAP()` and how to use those, see `vignette("Optimizers", package="gips")` or its [pkgdown page](https://przechoj.github.io/gips/articles/Optimizers.html).
241241
2. To learn more about the math and theory behind the `gips` package, see `vignette("Theory", package="gips")` or its [pkgdown page](https://przechoj.github.io/gips/articles/Theory.html).
242-
3. For an in-depth analysis of the package performance, capabilities, and comparison with other packages, see the article "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, available on [arXiv:2307.00790](https://arxiv.org/abs/2307.00790).
242+
3. For an in-depth analysis of the package performance, capabilities, and comparison with other packages, see the article "Learning permutation symmetries with gips in R" by `gips` developers Adam Chojecki, Paweł Morgen, and Bartosz Kołodziejek, [Journal of Statistical Software](https://doi.org/10.18637/jss.v112.i07).
243243

244244
```{r options_back, include = FALSE}
245245
options(old_options) # back to the original options

0 commit comments

Comments
 (0)