Skip to content

a dynamic and collaborative database for the morpho-geometric information of trilobites

Notifications You must be signed in to change notification settings

balsedie/trilomorph

Repository files navigation

TriloMorph

About the database

TriloMorph is an openly accessible database for the morpho-geometric information of trilobites, the main Palaeozoic group of marine arthropods1. The database records raw landmark and semilandmark information on trilobite cephala and pygidia following the protocol proposed by Serra et al1.

The purpose of this repository is to allow the constant input of new data into the database. If you are willing to use the database for analysis, we strongly suggest downloading the stable release that is accessible in the Digital repository of the Universidad Nacional de Córdoba and Zenodo2.

Further explanation about the R functions and how to download and analyze data hosted in this repository can be found here

If you would like to help with the maintenance of the dataset and file revision, do not hesitate to contact us3

Latest stable release DOI

Entering new data

You can enter more than one specimen at a time. The following explanation is for a single specimen, but uploding several specimens is possible as long as you include all specimens' metadata, shape files and pictures in the same commit (see below for detailed explanation).

Below we explain step by step the procedure to upload new data to TriloMorph:

Specimen

  • select the specimen

    Specimens included in the database have to be housed in official collections (preferentially having a collection number) or illustrated in the scientific literature. Specimens can be cephala and/or pigydia. Be sure that the selected specimen is not distorted, for cephala make sure that free cheeks are in place and not slightly disarticulated.

  • select the picture

    The picture used for the landmarking (see below) has to be a strictly dorsal picture of the specimen, either cephalon or pygidium. If the specimen is articulated make sure that both parts are photographed in dorsal view, if not use different pictures for each part.

    IMPORTANT: each picture has to include a graphical scale. If it is missing in the original publication, include one. You can easily include graphical scale bars with software such as ImageJ4

    We also ask to include the specimen's collection acronym and number in the figure. Make sure that the label does not cover any part of the specimen.

    Accepted formats are PNG and JPG/JPEG. Please avoid using TIFF files

  • name the picture

    The picture has to be named using the specimen's collection acronym and number. The file name must have the suffix _C when it is the cephalon, and _P for the pygidium. Important: If a single specimen and picture is used to landmark both cephalon and pygidium, two different files need to be created and named, one for the pygidum (_P), and one for the cephalon (_C)

Landmarking

  • select the specimen

  • select the picture

  • name the picture

  • landmark the specimen

    The specimen needs to be landmarked following the protocol in Serra et al1, which is explained in figure 2 and table 1

    You can use various landmarking software, namely tpsDig25, geomorph package for R6, and StereoMorph package for R7.

    If you are using the digitizeImages() function from the StereoMorph package7, you can use our templates for landmarks and curves for cephala and pygidia.

    Important: we strongly suggest to use digitizeImages() function from the StereoMorph package7 because tps files do not record missing curves, and therefore it is not possible to recognize which curve is missing. In case you still want to use tpsDig2, we suggest the following solution: in the order that is supposed to be the missing curve create a two-point curve anywhere. Thereby our ShapFix() function will (1) remove this specimen if the desired template includes the missing curve because it is impossible to resample semilandmarks, or (2) will be able to recognize all curves and remove the missing curve if the desired template does not include it.

    Please check that the final shape file is a XML-type (.txt)7 or TPS-type (.tps)5 file with the same name as the image file and their extension in lower case.

Complete the specimen's metadata

  • select the specimen

  • select the picture

  • name the picture

  • landmark the specimen

  • fill in the form

    You have to fill in the information about the specimen. It is very important to complete the form (particularly the stratigraphic fields) relative to the specimen, not the species

    A specimen's metadata is entered in the following form, please copy and paste it as it is (including hyphens) in a text editor and fill in each field. If there is missing information in a field, type NA. Fill one form per landmarked specimen. If a single specimen has cephalon and pygidum, just fill in a single form indicating that it has a cephalon and a pygidum.

-
  ID: 
  taxonomy: #this is the taxonomic information of the specimen. Don't fill anything else in this line
    genus: 
    gen_status: 
    subgen: 
    sp: 
    sp_status: 
    subsp: 
    orig_genus: 
    sp_author: 
    gen_author: 
    orig_sp: 
  ref.pic: 
  morphology: #this is the morphological information of the specimen. Don't fill anything else in this line
    cephalon: 
    cranidium: 
    pygidium: 
    eyes: 
    ontogeny: 
  geography:  #this is the geographic information of the specimen. Don't fill anything else in this line
    locality: 
    country: 
    state:  
    county: 
    lat: 
    long: 
  stratigraphy:  #this is the stratigraphic information of the specimen. Don't fill anything else in this line
    formation: 
    min_age: 
    max_age: 
    ref_age: 
    basin: 
    environment: 
  enterer: 
    metadata: 
    landmark: 
    date:
  comments:

The information needed and format for each field is described in Serra et al1 table 2.

Upload all data to TriloMorph

  • select the specimen

  • select the picture

  • name the picture

  • landmark the specimen

  • fill in the form

  • login to github

    If you don't have a github account you have to sign in first. You will only need an email, but don't be afraid using github is very simple.

    If it is your first time contributing to TriloMorph, we suggest to contact us3 first.

  • upload the metadata

    Go the specimens' metadata file and press the edit button.

    Important: if this is your first time contributing to TriloMorph, github will give a message indicating that you need to fork this repository. Go ahead and press "Fork this repository". Github might also tell you that your fork is outdated. Don't worry, just press "Update your fork".

    Once editing the metadata file, paste the newly filled form(s) in the second line (below the three hyphens [---])

After pasting the new form(s):

After pressing the button the github page will now have the heading Open a pull request

In this page you will have a field where you must upload the following files:

  • upload the picture file(s)

    Please note that the maximum size for images is 10MB

  • upload the landmark file(s)

Once you've uploaded all files, the field will look like this. You can also take a look at the preview tab to make sure that the image(s) have been uploaded correctly.

Then you must press the "Create pull request" button.

The final step should look something similar to this

Include all new references

  • select the specimen
  • select the picture
  • name the picture
  • landmark the specimen
  • fill in the form
  • login to github
  • upload the metadata
  • upload picture file
  • upload the landmark file

After submitting the specimen's metadata, shape file and picture, you need to

  • update references list

    You have to include the literature references used in the new record. To add new references, go to the references list and press the edit button. Add all new references using the following formats,

    for single author: Author year, Author I. (year). Title. Journal. Volume pages, doi

    for two authors: Author Author year, Author I. Author I. (year). Title. Journal. Volume pages, doi

    for multiple authors: Author et al year, Author I. Author I. Author I. (year). Title. Journal. Volume pages, doi

    Paste the new references in the list, press the "commit changes..." button and follow the steps.

If it is the first time you contribute with data, you also need to

  • update the list of contributors

    You have to include your personal information. Go to the list of contributors and press the edit button and then add all your information using the following format,

    Full Name, enterer ID*, ORCID ID, Affilation, email, github username

    *enterer ID is the name you used in the enterer field of the specimen's metadata

    Paste the new references in the list, press the "commit changes..." button and follow the steps.

Wait for file revison and acceptance

  • select the specimen
  • select the picture
  • name the picture
  • landmark the specimen
  • fill in the form
  • login to github
  • upload the metadata
  • upload picture file
  • upload the landmark file
  • update references list
  • update list of contributors (if necessary)

After uploading all files of the new landmarked specimen(s), the new information will not be immediately available in the database. The TriloMorph maintainers3 will review all files, check that there is no conflict, and accept your new data within a week or two. After accepting the new data you will receive an email informing that the data was merged to TriloMorph. If you need your data to be reviewed and accepted faster please contact us3.

Licence

All material is distributed under Creative Commons Attribution 4.0 International [CC BY 4.0] licence terms8.

If you use the database please cite it using the doi or handle and the version of the stable release. A bibtex version of the citable stable release is available here.

In case you use Trilomorph for a publication, we strongly suggest you to acknowledge the main contributors to the analyzed dataset. You can check the contributors in the accompanying metadata and their full names and additional information in the list of Trilomorph contributors.

Once your work gets published, we suggest you to send us the full reference to include it in the list of publications that use TriloMorph.

References

Footnotes

  1. Serra F., Balseiro D., Monnet C., et al. 2023. A dynamic and collaborative database for morphogeometric information of trilobites. Scientific Data 10:841. DOI: 10.1038/s41597-023-02724-9 2 3 4

  2. Latest and previous stable releases are available at https://rdu.unc.edu.ar/handle/11086/547753 and DOI: 10.5281/zenodo.8033445

  3. The data base is currently maintained by Diego Balseiro and Fernanda Serra 2 3 4

  4. Schneider C.A., Rasband W.S. and Eliceiri K.W. 2012. NIH Image to ImageJ: 25 years of image analysis. Nature Methods 9:671–675. DOI: 10.1038/nmeth.2089 Download ImageJ

  5. Rohlf F.J. 2015. The tps series of software. Hystrix, the Italian Journal of Mammalogy 26:9-12. DOI: 10.4404/hystrix-26.1-11264 2

  6. Adams D.C, Collyer M.L. and Kaliontzopoulou A. 2020. Geomorph: Software for geometric morphometric analyses. R package version 3.2.1. https://cran.r-project.org/package=geomorph.

  7. Olsen A.M. and Westneat M.W. 2015. StereoMorph: an R package for the collection of 3D landmarks and curves using a stereo camera set-up. Methods in Ecology and Evolution 6:351-356. DOI: 10.1111/2041-210X.12326. 2 3 4

  8. https://creativecommons.org/licenses/by/4.0/

About

a dynamic and collaborative database for the morpho-geometric information of trilobites

Resources

Stars

Watchers

Forks

Packages

No packages published