Please include a summary of your function.
Please include a summary of the motivation and context of this function.
- I have read the Palaeoverse standards and structure
- I have performed a self-review of my code.
- I have added function documentation.
- I have provided sufficient examples of implementation.
- If it is a core feature, I have added thorough tests.