Skip to content

Commit

Permalink
Update 12-eln.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jvddorpe authored Oct 11, 2023
1 parent 498b591 commit 58e1dcd
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions docs/_Research-Data-Management/12-eln.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ An Electronic Lab Notebook (ELN) is a software meant for documenting experiments
As well as documenting your experiments, resulting research data and processes, a physical lab notebook is also intended to communicate your work (e.g. why experiments were initiated?). It also serves as a legal document to prove patents and defend your data against accusations of misconduct. Finally, it is your scientific legacy in the laboratory {% cite n4m_wc_elns_2023 %}.

## Additional uses of ELNs
ELNs offer features and functions that can pave the way for significant time savings and knowledge transfer in daily laboratory work. For example, ELNs support the annotation of raw data (e.g. with tags or metadata {% cite rathmann_2021 vandendorpe_nd %} without having to switch between different media formats. Annotating data makes it searchable, discoverable, traceable and reusable {% cite vandendorpe_nd %}. ELNs also bring data and their description closer together through embedded multimedia files (e.g. videos of experimental setups), links to shared resources (e.g. chemical databases or analysis software), links to other experiments, and direct links to (raw) data sets and analysis workflows {% cite rehwald_2022 %}. ELNs also allow for the versioning of experiment descriptions {% cite rehwald_2022 %} and the structuring and visualisation of workflows and processes {% cite rathmann_2021 %}. ELNs also have the ability to manage inventories of samples, reagents and other supplies, and track equipment and equipment maintenance schedules {% cite lma_rdmwg %}. ELNs also provide for collaboration {% cite lma_rdmwg %} through a common medium {% cite rehwald_2022 %}. Last but not least, ELNs provide for auditing {% cite lma_rdmwg %}, security and safety. Indeed, ELNs are fireproof, waterproof and cannot be lost, misplaced or stolen. ELNs can also be automatically backed up. They allow timestamping (RFC 3161 using DFN-PKI) and finalisation to prevent further changes {% cite rehwald_2022 %}. They also support electronic signatures {% cite cozatl_2021 %} and require access management {% cite rehwald_2022 %}.
ELNs offer features and functions that can pave the way for significant time savings and knowledge transfer in daily laboratory work. For example, ELNs support the annotation of raw data (e.g. with tags or metadata {% cite rathmann_2021 vandendorpe_nd %} without having to switch between different media formats. Annotating data makes it searchable, discoverable, traceable and reusable {% cite vandendorpe_nd %}. ELNs also bring data and their description closer together through embedded multimedia files (e.g. videos of experimental setups), links to shared resources (e.g. chemical databases or analysis software), links to other experiments, and direct links to (raw) data sets and analysis workflows {% cite rehwald_2022 %}. ELNs also allow for the versioning of experiment descriptions {% cite rehwald_2022 %} and the structuring and visualisation of workflows and processes {% cite rathmann_2021 %}. ELNs also have the ability to manage inventories of samples, reagents and other supplies, and track equipment and equipment maintenance schedules {% cite lma_rdmwg %}. ELNs also provide for collaboration {% cite lma_rdmwg %} through a common medium {% cite rehwald_2022 %}. Last but not least, ELNs provide for auditing {% cite lma_rdmwg %}, security and safety. Indeed, ELNs are fireproof, waterproof and cannot be lost, misplaced or stolen. ELNs can also be automatically backed up. They allow timestamping (RFC 3161 using DFN-PKI) and finalisation to prevent further changes {% cite rehwald_2022 %}. They also support electronic signatures {% cite cozatl_2021 %} and require access management {% cite rehwald_2022 %}.

## What ELNs should not be used for
ELNs are not data publishing platforms and are not suitable for storing large files. Large files require special technology for secure storage (e.g. Object Store, Nextcloud), but can still be linked in the ELN {% cite rehwald_2022 %}.
Expand All @@ -24,7 +24,7 @@ ELNs are not data publishing platforms and are not suitable for storing large fi
ELNs increase the efficiency of everyday tasks by providing time-saving features and functions such as search and filtering {% cite vandendorpe_nd %}. ELNs also take advantage of standardisation {% cite rathmann_2021 %}: they have the ability to create templates such as protocols, Standard Operating Procedures (SOPs) and workflows. This facilitates data documentation with metadata {% cite vandendorpe_nd %} and supports clarity and organisation of data and protocols {% cite n4m_wc_elns_2023 %}. ELNs also provide ubiquitous access {% cite vandendorpe_nd %}: protocols, observations, notes and other data can be entered using a computer or mobile device {% cite lma_rdmwg %}.

## Connection to a digital research environment
ELNs are linked to a digital research environment {% cite vandendorpe_nd %}, for example through their import and export capabilities {% cite bobrov_2021 %}. ELNs can also provide seamless interfaces to other programmes, such as Application Programming Interfaces (APIs) {% cite bobrov_2021 %}. This networked aspect of ELNs enables them to play a central role in an institution's [Research Data Management](https://nfdi4microbiota.github.io/nfdi4microbiota-knowledge-base/Research-Data-Management/02-rdm) (RDM) strategy. Indeed, ELNs can be linked and contribute to almost each step of the research data lifecycle:
ELNs are linked to a digital research environment {% cite vandendorpe_nd %}, for example through their import and export capabilities {% cite bobrov_2021 %}. ELNs can also provide seamless interfaces to other programmes, such as Application Programming Interfaces (APIs) {% cite bobrov_2021 %}. This networked aspect of ELNs enables them to play a central role in an institution's [Research Data Management](https://nfdi4microbiota.github.io/nfdi4microbiota-knowledge-base/Research-Data-Management/02-rdm) (RDM) strategy. Indeed, ELNs can be linked and contribute to almost each step of the research data lifecycle:

* **Data collection:** ELNs can automatically record results from measuring instruments {% cite vandendorpe_2020 rathmann_2021 %} and retrieve data from databases for actively used data {% cite assmann_2022 Krause_2016 %}.

Expand All @@ -33,23 +33,30 @@ ELNs are linked to a digital research environment {% cite vandendorpe_nd %}, for
* **Data sharing and publishing:** ELNs facilitate collaboration by allowing data already in digital form to be used directly in the ELN {% cite vandendorpe_nd %}. ELNs also make it easy to share information about the project, data and documentation with collaborators {% cite lma_rdmwg %}, for example via the cloud {% cite n4m_wc_elns_2023 %}. All this also facilitates collaboration with the institutional library, research data centre and IT centre {% cite vandendorpe_nd %}.
ELNs also facilitate publishing by providing a means to prepare research data for publication {% cite vandendorpe_2020 %} and by integrating with other applications such as Mendeley, Dataverse and PubMed {% cite lma_rdmwg n4m_wc_elns_2023 %}.

* **Digital preservation:** ELNs facilitate the creation of backups {% cite rathmann_2021 %} and can include links to the location of large amounts of data {% cite bobrov_2021 %}. They also facilitate the archiving of data and its documentation {% cite vandendorpe_nd n4m_wc_elns_2023 %} by providing a means to prepare research data for digital preservation {% cite vandendorpe_2020 %} and by being linked to digital preservation systems.
* **Digital preservation:** ELNs facilitate the creation of backups {% cite rathmann_2021 %} and can include links to the location of large amounts of data {% cite bobrov_2021 %}. They also facilitate the archiving of data and its documentation {% cite vandendorpe_nd n4m_wc_elns_2023 %} by providing a means to prepare research data for digital preservation {% cite vandendorpe_2020 %} and by being linked to digital preservation systems.

* **Data discovery and reuse:** ELNs can prove provenance {% cite lma_rdmwg %}.

## Complying to the FAIR Data Principles
ELNs support the FAIR Data Principles {% cite lma_rdmwg %}:

* **Findability:** ELNs support findability by providing comprehensive search capabilities (e.g. database search, full-text search, conditional search), by supporting the assignment of metadata and tags (e.g. through extraction from documents), by assigning persistent identifiers such as the Digital Object Identifier (DOI) and by linking to data repositories and digital preservation systems {% cite bobrov_2021 %}.
* **Findability:** ELNs support findability by providing comprehensive search capabilities (e.g. database search, full-text search, conditional search), by supporting the assignment of metadata and tags (e.g. through extraction from documents), by assigning persistent identifiers such as the Digital Object Identifier (DOI) and by linking to data repositories and digital preservation systems {% cite bobrov_2021 %}.

* **Accessibility:** ELNs support accessibility by storing data in a fixed and accessible location, rather than on the researcher's USB stick or portable hard drive {% cite bobrov_2021 %}.
* **Accessibility:** ELNs support accessibility by storing data in a fixed and accessible location, rather than on the researcher's USB stick or portable hard drive {% cite bobrov_2021 %}.

* **Interoperability:** ELNs support interoperability by supporting the use of controlled vocabularies in metadata and allowing export to standard formats {% cite bobrov_2021 %}.
* **Interoperability:** ELNs support interoperability by supporting the use of controlled vocabularies in metadata and allowing export to standard formats {% cite bobrov_2021 %}.

* **Reusability:** ELNs support reusability by providing detailed provenance information through audit trails and documentation of both data generation (e.g. method logs) and equipment used {% cite bobrov_2021 %}.
* **Reusability:** ELNs support reusability by providing detailed provenance information through audit trails and documentation of both data generation (e.g. method logs) and equipment used {% cite bobrov_2021 %}.

# Contributing to Good Scientific Practice (GSP)
ELNs make an important contribution to Good Scientific Practice (GSP) by facilitating the tracking, tracing and documentation of research processes and results over time {% cite vandendorpe_nd %}. They enable this by providing functions and features such as electronic signatures, version control {% cite vandendorpe_2020 %}, authentication, 'freezing' of work status, searchability and tagging of entries, and audit trail {% cite bobrov_2021 %}.

ELNs also prevent data loss by eliminating problems with data deletion {% cite bobrov_2021 %}, illegible handwriting, media discontinuities between handwritten and digital entries {% cite vandendorpe_nd %}, damaged paper notebooks, and researchers moving on {% cite lma_rdmwg %}.

Finally, ELNs contribute to GSP by providing for data security and collaboration (see Data sharing & publishing) {% cite lma_rdmwg %}.

# Further resources
* [ELN Finder - Demo](https://eln-finder.ulb.tu-darmstadt.de/home) - Tool to help researchers searching and selecting a suitable ELN thanks to more than 40 filter criteria.
* [ELN Finder - Demo](https://eln-finder.ulb.tu-darmstadt.de/home) - Tool to help researchers searching and selecting a suitable ELN thanks to more than 40 filter criteria.
* ELN Filter - Selection of ELNs that are suitable for the life sciences and that can be filtered out according to criteria ([English](https://www.publisso.de/fileadmin/user_upload/PUBLISSO/PUBLISSO_ELN-Filter_2021-06_english.xlsx), [German](https://www.publisso.de/fileadmin/user_upload/PUBLISSO/PUBLISSO_ELN-Filter_2020-12-01.xlsx)).
* ELN Guide - ELNs in the context of research data management and good research practice – a guide for the life sciences ([English](https://dx.doi.org/10.4126/FRL01-006425772), [German](https://dx.doi.org/10.4126/FRL01-006422868)).
* Free consultation sessions to get advice on the selection and introduction of an ELN (<[email protected]>).
Expand Down

0 comments on commit 58e1dcd

Please sign in to comment.