Skip to content

Commit 8ebfa04

Browse files
committed
bump release to v1.0.0 w/ NEWS and w/o CHANGELOG
* this fixes #20 * add CRAN comments file * update the wordlist accordingly
1 parent 226a0ec commit 8ebfa04

File tree

6 files changed

+57
-22
lines changed

6 files changed

+57
-22
lines changed

.Rbuildignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@
1313
^codecov\.yml$
1414
^doc$
1515
^Meta$
16+
^cran-comments\.md$

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: maldipickr
22
Title: Dereplicate And Cherry-Pick Mass Spectrometry Spectra
3-
Version: 0.1.0
3+
Version: 1.0.0
44
Authors@R: c(
55
person("Charlie", "Pauvert", , "[email protected]", role = c("aut", "cre", "cph"),
66
comment = c(ORCID = "0000-0001-9832-2507")),

NEWS.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,49 @@
1+
# maldipickr 1.0.0
2+
3+
## Changed
4+
5+
* (**BREAKING**) `read_biotyper_report()` first column is now `name` instead of `spot`, meaning `read_many_biotyper_reports()` renames all the `name` columns to `original_name`. This was to `pick_spectra()` easily usable with taxonomy identification reports (`38a614173fd21315a40e0823600a2082fa0935bb`)
6+
* (**BREAKING**) All functions now follow the `verb_concept` nomenclature, meaning clustering functions are now renamed accordingly (#24):
7+
- Change `similarity_to_clusters()` to `delineate_with_similarity()`
8+
- Change `identification_to_clusters()` to `delineate_with_identification()`
9+
* Refactor the `delineate_with_similarity()` clustering function (formerly: `similarity_to_clusters()`) without using the `{igraph}` nor `{tidygraph}` R packages, for fewer dependencies and simpler codebase (#18)
10+
* Update the `DESCRIPTION` to include the Strejcek reference (#22) and better highlight the package added-value
11+
* Refactor the `pkgdown` website with a more accessible font and color schema inline with the logo color palette
12+
* Change the vignettes titles and outline to better structure the documents
13+
* Refactor cosine similarity computation example by highlighting the dedicated `coop::tcosine()` instead of the `t() %>% coop::cosine()`
14+
15+
## Added
16+
17+
* Add long or wide output format for `read_biotyper_report()` (#12)
18+
* Document how to quickstart with the `{maldipickr}` package for those in a hurry (#15)
19+
* Document more precisely how to install tagged release of `{maldipickr}` package
20+
* Add better tests for `merge_processed_spectra()` (`b39c1313fd38239b4b1821a243c9debf467fd092`)
21+
* Document authors list according to CRAN policy
22+
* Add CRAN comments file to track submission notes
23+
24+
## Removed
25+
26+
* Deprecate the `CHANGELOG.md` in favor of the R specific `NEWS.md` (#20)
27+
* Remove redundant check after symbolic links creation (#19)
28+
29+
## Fixed
30+
31+
* Fix `summarise()` usage in `pick_spectra()`, with code simplification (#11)
32+
* Remove symbolic links created for importing acqu spectra files (#21)
33+
* Fix CRAN warnings regarding `qpdf` (`3b19dd36a6ec0f5dc277418c98977c526981b6e3`)
34+
* Fix masked relevant `to_pick` column in the vignette (#17)
35+
36+
# maldipickr 0.1.1
37+
38+
## Added
39+
40+
* Add citation file for R ([`CITATION`](inst/CITATION)) and for GitHub ([`CITATION.cff`](CITATION.cff))
41+
* Add a [`CHANGELOG.md`](CHANGELOG.md) ([Common Changelog](https://common-changelog.org))
42+
43+
## Changed
44+
45+
* Improve the package description according to CRAN recommendations
46+
147
# maldipickr 0.1.0
248

349
* First stable version

cran-comments.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
## R CMD check results
2+
3+
0 errors | 0 warnings | 1 note
4+
5+
* This is a new release.

dev/CHANGELOG.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

inst/WORDLIST

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Bruker
66
CMD
77
Canck
88
Carlier
9+
Changelog
910
Cleenwerck
1011
Cnockaert
1112
Dawyndt
@@ -43,8 +44,10 @@ Uhlik
4344
Vandamme
4445
Verheyde
4546
Wieme
47+
acqu
4648
al
4749
bruker
50+
codebase
4851
codecov
4952
csv
5053
dereplicate
@@ -61,6 +64,7 @@ magrittr
6164
maldi
6265
modularity
6366
natively
67+
quickstart
6468
rRNA
6569
scalable
6670
spectrometry

0 commit comments

Comments
 (0)