Merge pull request #11 from MindTheGap-ERC/dev

Dev

.Rbuildignore

@@ -7,5 +7,6 @@
 ^pkgdown$
 
 ^CONTRIBUTING.md$
+^CITATION.cff$
 ^doc$
 ^Meta$

CITATION.cff

@@ -0,0 +1,49 @@
+# This CITATION.cff file was generated with cffinit.
+# Visit https://bit.ly/cffinit to generate yours today!
+
+cff-version: 1.2.0
+title: >-
+  StratPal: R package for stratigraphic paleobiology
+  modeling pipelines
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+type: software
+authors:
+  - given-names: Niklas
+    family-names: Hohmann
+    email: [email protected]
+    affiliation: Utrecht University
+    orcid: 'https://orcid.org/0000-0003-1559-1838'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.12790995
+    description: DOI of version 0.1.0
+repository-code: 'https://github.com/MindTheGap-ERC/StratPal'
+url: 'https://mindthegap-erc.github.io/StratPal/'
+repository: 'https://zenodo.org/doi/10.5281/zenodo.10782634'
+abstract: >-
+  The fossil record is a joint expression of ecological,
+  taphonomic, evolutionary, and stratigraphic processes
+  (Holland and Patzkowsky, 2012). This package allowing to
+  simulate biological processes in the time domain (e.g.,
+  trait evolution, fossil abundance), and examine how their
+  expression in the rock record (stratigraphic domain) is
+  influenced based on age-depth models, ecological niche
+  models, and taphonomic effects. Functions simulating
+  common processes used in modeling trait evolution or event
+  type data such as first/last occurrences are provided and
+  can be used standalone or as part of a pipeline. The
+  package comes with example data sets and tutorials in
+  several vignettes, which can be used as a template to set
+  up one's own simulation.
+keywords:
+  - Stratigraphic Paleobiology
+  - Stratigraphy
+  - Paleontology
+  - Palaeontology
+  - Paleobiology
+license: Apache-2.0
+commit: d476968672d99001c2485763f0f4fdc7b9458973
+version: 0.1.0
+date-released: '2024-07-22'

README.md

@@ -73,6 +73,14 @@ Apache 2.0, see LICENSE file for license text.
 
 Copyright 2024 Netherlands eScience Center and Utrecht University
 
+## Citation
+
+To cite the package, please use
+
+-   Hohmann, Niklas. 2024. "StratPal: R package for stratigraphic paleobiology modeling pipelines (v0.1.0)." Zenodo. <https://doi.org/10.5281/zenodo.12790995>.
+
+Alternatively, you can also use the CITATION.cff file at the root of the repository, or `citation("StratPal")`.
+
 ## References {#References}
 
 -   Holland, Steven M. and Patzkowsky, Mark E. "Stratigraphic Paleobiology : Understanding the Distribution of Fossil Taxa in Time and Space."" The University of Chicago Press; 2012.