Skip to content

Commit bb51629

Browse files
dfalsterclaude
andauthored
docs: AusTraits family cross-linking, acknowledgements & citations (#286)
* docs: add acknowledgement, fix citation version & app URL Add the canonical partner + ARDC/NCRIS co-investment acknowledgement (the AusTraits family block is already present on master). Make the inst/CITATION package-version note track DESCRIPTION (was pinned at 1.1.4; DESCRIPTION is 2.0.0) and update the rendered README citation accordingly. Point the Shiny app link at the new AWS host app.austraits.org/APCalign-app. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> * docs: add CITATION.cff for GitHub 'Cite this repository' Add a validated CITATION.cff (generated with {cffr}) so GitHub's citation widget works, with the key paper as the preferred citation. inst/CITATION added/refreshed to keep citation() consistent with the CFF. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 3607d47 commit bb51629

4 files changed

Lines changed: 139 additions & 5 deletions

File tree

CITATION.cff

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# ------------------------------------------------
2+
# CITATION.cff file created with {cffr} R package
3+
# See also: https://docs.ropensci.org/cffr/
4+
# ------------------------------------------------
5+
6+
cff-version: 1.2.0
7+
message: 'To cite package "APCalign" in publications use:'
8+
type: software
9+
license: MIT
10+
title: 'APCalign: Resolving Plant Taxon Names Using the Australian Plant Census'
11+
version: 2.0.0
12+
doi: 10.1071/BT24014
13+
identifiers:
14+
- type: doi
15+
value: 10.32614/CRAN.package.APCalign
16+
- type: url
17+
value: https://doi.org/10.1071/BT24014
18+
abstract: The process of resolving and updating taxon names is necessary when working
19+
with biodiversity data. 'APCalign' uses the Australian Plant Census (APC) and the
20+
Australian Plant Name Index (APNI) to align and update plant taxon names to current,
21+
accepted standards. 'APCalign' also supplies information about the establishment
22+
status (i.e. native or introduced) of plant taxa across different states/territories.
23+
authors:
24+
- family-names: Wenk
25+
given-names: Elizabeth
26+
email: e.wenk@unsw.edu.au
27+
orcid: https://orcid.org/0000-0001-5640-5910
28+
- family-names: Falster
29+
given-names: Daniel
30+
email: daniel.falster@unsw.edu.au
31+
orcid: https://orcid.org/0000-0002-9814-092X
32+
- family-names: Cornwell
33+
given-names: Will
34+
email: w.cornwell@unsw.edu.au
35+
orcid: https://orcid.org/0000-0003-4080-4073
36+
- family-names: Kar
37+
given-names: Fonti
38+
email: f.kar@unsw.edu.au
39+
orcid: https://orcid.org/0000-0002-2760-3974
40+
preferred-citation:
41+
type: article
42+
title: 'APCalign: an R package workflow and app for aligning and updating flora
43+
names to the Australian Plant Census'
44+
authors:
45+
- family-names: Wenk
46+
given-names: Elizabeth
47+
email: e.wenk@unsw.edu.au
48+
orcid: https://orcid.org/0000-0001-5640-5910
49+
- family-names: Cornwell
50+
given-names: Will
51+
email: w.cornwell@unsw.edu.au
52+
orcid: https://orcid.org/0000-0003-4080-4073
53+
- family-names: Fuchs
54+
given-names: Ann
55+
email: anne.fuchs@dcceew.gov.au
56+
orcid: https://orcid.org/0000-0001-5737-8803
57+
- family-names: Kar
58+
given-names: Fonti
59+
email: f.kar@unsw.edu.au
60+
orcid: https://orcid.org/0000-0002-2760-3974
61+
- family-names: Monro
62+
given-names: Anna
63+
email: anna.monro@dcceew.gov.au
64+
orcid: https://orcid.org/0000-0001-9031-2670
65+
- family-names: Sauquet
66+
given-names: Herve
67+
email: herve.sauquet@botanicgardens.nsw.gov.au
68+
orcid: https://orcid.org/0000-0001-8305-3236
69+
- family-names: Stephens
70+
given-names: Ruby
71+
email: stephenseruby@gmail.com
72+
orcid: https://orcid.org/0000-0002-3767-2690
73+
- family-names: Falster
74+
given-names: Daniel
75+
email: daniel.falster@unsw.edu.au
76+
orcid: https://orcid.org/0000-0002-9814-092X
77+
journal: Australian Journal of Botany
78+
volume: '72'
79+
issue: '4'
80+
year: '2024'
81+
publisher:
82+
name: CSIRO Publishing
83+
notes: 'R package version: 2.0.0'
84+
url: https://doi.org/10.1071/BT24014
85+
doi: 10.1071/BT24014
86+
repository: https://CRAN.R-project.org/package=APCalign
87+
repository-code: https://github.com/traitecoevo/APCalign
88+
url: https://traitecoevo.github.io/APCalign/
89+
contact:
90+
- family-names: Wenk
91+
given-names: Elizabeth
92+
email: e.wenk@unsw.edu.au
93+
orcid: https://orcid.org/0000-0001-5640-5910
94+
keywords:
95+
- r-package
96+
- taxonomy
97+
- australia
98+
- plants
99+
- flora
100+

README.Rmd

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ install.packages("remotes")
5757
remotes::install_github("traitecoevo/APCalign")
5858
```
5959

60-
Or for the ShinyApp head to [unsw.shinyapps.io/APCalign-app](https://unsw.shinyapps.io/APCalign-app/)
60+
Or for the ShinyApp head to [app.austraits.org/APCalign-app](https://app.austraits.org/APCalign-app/)
6161

6262
## A quick demo
6363

@@ -171,3 +171,20 @@ read the [issue & labelling guide](https://github.com/traitecoevo/austraits-meta
171171
in [`austraits-meta`](https://github.com/traitecoevo/austraits-meta) — the family's cross-package
172172
knowledge and governance hub — before filing.
173173

174+
175+
## Acknowledgements
176+
177+
AusTraits is made possible by contributions from our partner organisations — the
178+
[University of New South Wales](https://www.unsw.edu.au/),
179+
[Western Sydney University](https://www.westernsydney.edu.au/),
180+
[Botanic Gardens of Sydney](https://www.botanicgardens.org.au/),
181+
[the University of Melbourne](https://www.unimelb.edu.au/),
182+
the [Atlas of Living Australia](https://www.ala.org.au/), and the Australian Government
183+
[Department of Climate Change, Energy, the Environment and Water](https://www.dcceew.gov.au) — and
184+
from our [advisory board, data contributors, and past partners](https://austraits.org/team/team-partners.html).
185+
186+
AusTraits is a co-investment partnership with the
187+
[Australian Research Data Commons](https://ardc.edu.au/) (ARDC) through the Planet Research Data
188+
Commons ([DOI: 10.3565/nyk4-4r91](https://doi.org/10.3565/nyk4-4r91)). The ARDC is enabled by the
189+
Australian Government's [National Collaborative Research Infrastructure Strategy](https://www.education.gov.au/ncris)
190+
(NCRIS).

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ remotes::install_github("traitecoevo/APCalign")
5858
```
5959

6060
Or for the ShinyApp head to
61-
[unsw.shinyapps.io/APCalign-app](https://unsw.shinyapps.io/APCalign-app/)
61+
[app.austraits.org/APCalign-app](https://app.austraits.org/APCalign-app/)
6262

6363
## A quick demo
6464

@@ -226,7 +226,7 @@ citation("APCalign")
226226
#> Wenk E, Cornwell W, Fuchs A, Kar F, Monro A, Sauquet H, Stephens R,
227227
#> Falster D (2024). "APCalign: an R package workflow and app for
228228
#> aligning and updating flora names to the Australian Plant Census."
229-
#> _Australian Journal of Botany_, *72*(4). R package version: 1.1.4,
229+
#> _Australian Journal of Botany_, *72*(4). R package version: 2.0.0,
230230
#> <https://doi.org/10.1071/BT24014>.
231231
#>
232232
#> A BibTeX entry for LaTeX users is
@@ -239,7 +239,7 @@ citation("APCalign")
239239
#> number = {4},
240240
#> year = {2024},
241241
#> publisher = {CSIRO Publishing},
242-
#> note = {R package version: 1.1.4},
242+
#> note = {R package version: 2.0.0},
243243
#> url = {https://doi.org/10.1071/BT24014},
244244
#> }
245245
```
@@ -268,3 +268,20 @@ Contributing? Issues across the family are tracked on one board,
268268
read the [issue & labelling guide](https://github.com/traitecoevo/austraits-meta/blob/main/governance/issue-guide.md)
269269
in [`austraits-meta`](https://github.com/traitecoevo/austraits-meta) — the family's cross-package
270270
knowledge and governance hub — before filing.
271+
272+
## Acknowledgements
273+
274+
AusTraits is made possible by contributions from our partner organisations — the
275+
[University of New South Wales](https://www.unsw.edu.au/),
276+
[Western Sydney University](https://www.westernsydney.edu.au/),
277+
[Botanic Gardens of Sydney](https://www.botanicgardens.org.au/),
278+
[the University of Melbourne](https://www.unimelb.edu.au/),
279+
the [Atlas of Living Australia](https://www.ala.org.au/), and the Australian Government
280+
[Department of Climate Change, Energy, the Environment and Water](https://www.dcceew.gov.au) — and
281+
from our [advisory board, data contributors, and past partners](https://austraits.org/team/team-partners.html).
282+
283+
AusTraits is a co-investment partnership with the
284+
[Australian Research Data Commons](https://ardc.edu.au/) (ARDC) through the Planet Research Data
285+
Commons ([DOI: 10.3565/nyk4-4r91](https://doi.org/10.3565/nyk4-4r91)). The ARDC is enabled by the
286+
Australian Government's [National Collaborative Research Infrastructure Strategy](https://www.education.gov.au/ncris)
287+
(NCRIS).

inst/CITATION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ bibentry(
1616
number = 4,
1717
year = 2024,
1818
publisher="CSIRO Publishing",
19-
note = "R package version: 1.1.4",
19+
note = paste("R package version:", meta$Version),
2020
url = "https://doi.org/10.1071/BT24014"
2121
)

0 commit comments

Comments
 (0)