Micro-Meta App: an interactive software tool to
facilitate the collection of microscopy metadata
based on community-driven specifications
Alex Rigano
1
, Shannon Ehmsen
2
, (https://orcid.org/0000-0001-8835-787X) Serkan Utku Ozturk
2
, Joel Ryan
3
, Alexander Balashov
2
,
Mathias Hammer
4
, (https://orcid.org/0000-0002-2289-0652) Koray Kirli
2
, (https://orcid.org/0000-0003-3889-468X) Karl Bellve
1
,
(https://orcid.org/0000-0001-7471-2244) Ulrike Boehm
#
5
, (https://orcid.org/0000-0003-1622-663X) Claire M. Brown
#3
,
(https://orcid.org/0000-0003-3883-8215) James J. Chambers
#
6
, (https://orcid.org/0000-0002-7367-9603) Robert A. Coleman
7
,
(https://orcid.org/0000-0003-3417-0713) Andrea Cosolo
2
, (https://orcid.org/0000-0001-5965-5405) Orestis Faklaris
#
8
,
(https://orcid.org/0000-0002-4651-3480) Kevin Fogarty
1
, (https://orcid.org/0000-0001-5069-0730) Thomas Guilbert
9
,
(https://orcid.org/0000-0001-7374-8245) Anna B. Hamacher
10
, (https://orcid.org/0000-0001-6853-1228) Michelle S. Itano
11
, Daniel
P. Keeley
11
, (https://orcid.org/0000-0001-6523-7496) Susanne Kunis
12
, (https://orcid.org/0000-0002-8783-8599) Judith Lacoste
#
13
,
(https://orcid.org/0000-0002-3853-1187) Alex Laude
#
14
, Willa Ma
11
, (https://orcid.org/0000-0002-2392-8640) Marco Marcello
15
,
(https://orcid.org/0000-0002-5983-2296) Paula Montero-Llopis
16
, (http://orcid.org/0000-0002-1895-4772) Glyn Nelson
#14
,
(https://orcid.org/0000-0002-9397-8475) Roland Nitschke
#
17
, (https://orcid.org/0000-0001-8569-0466) Jaime A. Pimentel
#
18
,
(https://orcid.org/0000-0001-7734-3771) Stefanie Weidtkamp-Peters
10
, Peter J. Park
2
, (https://orcid.org/0000-0002-5019-7652) Burak
Alver
2
, David Grunwald
3
, and (https://orcid.org/0000-0002-1069-1816) Caterina Strambio-De-Castillia
#1
# Members of the Bioimaging North America Quality Control and Data Management Working Group
Keywords: bioimage informatics, calibration, data formats, data provenance, data standards, image quality, imaging, metadata, microscopy, open
microscopy quality control, reproducibility
Abbreviation list: BINA, BioImaging North America; 4DN, 4D Nucleome; FAIR, Findable Accessible Interoperable and Reproducible; OME, Open
Microscopy Environment; QUAREP-LiMi, QUAlity Assessment and REProducibility for Instrument and Images in Light Microscopy
1
Program in Molecular Medicine, UMass Medical School, Worcester MA 01605, USA
2
Department of Biomedical Informatics, Harvard Medical School, Boston, MA 02115, USA
3
Advanced BioImaging Facility (ABIF), McGill University, Montreal, Quebec, H3G 0B1, Canada
4
RNA Therapeutics Institute, UMass Medical School, Worcester MA 01605, USA
5
Janelia Research Campus, Howard Hughes Medical Institute, Ashburn, VA 20147, USA
6
Institute for Applied Life Sciences, University of Massachusetts, Amherst, MA 01003, USA
7
Gruss-Lipper Biophotonics Center, Department of Anatomy and Structural Biology, Albert Einstein College of Medicine, Bronx, NY
10461
8
BCM, Univ. Montpellier, CNRS, INSERM, Montpellier, France
9
Institut Cochin, Inserm U1016-CNRS UMR8104-Université de Paris, 75014 Paris, France
10
Center for Advanced Imaging, Heinrich-Heine University Duesseldorf, 40225 Düsseldorf, Germany
11
UNC Neuroscience Microscopy Core Facility, University of North Carolina, Chapel Hill, NC 27599-7250
12
Department of Biology/Chemistry and Centre for Cellular Nanoanalytics, University Osnabrueck, 49076 Osnabrück, Germany
13
MIA Cellavie Inc., Montreal, Quebec, H1K 4G6, Canada
14
Bioimaging Unit, Newcastle University, Newcastle upon Tyne, NE2 4HH, UK
15
Center for Cell Imaging, University of Liverpool, Liverpool, L69 3BE, UK
16
Microscopy Resources of the North Quad, University of Harvard Medical School, Boston, MA 02115
17
Life Imaging Center and BIOSS Centre for Biological Signaling Studies, Albert-Ludwigs-University Freiburg, Freiburg, 79104,
Germany
18
Instituto de Biotecnologıa, Universidad Nacional Autonoma de Mexico, Cuernavaca, Morelos, 62210, México
.CC-BY-NC-ND 4.0 International licenseavailable under a
was not certified by peer review) is the author/funder, who has granted bioRxiv a license to display the preprint in perpetuity. It is made
The copyright holder for this preprint (whichthis version posted June 1, 2021. ; https://doi.org/10.1101/2021.05.31.446382doi: bioRxiv preprint
2
Abstract
For the information content of microscopy images to be appropriately interpreted, reproduced, and meet FAIR
(Findable Accessible Interoperable and Reusable) principles, they should be accompanied by detailed descriptions
of microscope hardware, image acquisition settings, image pixel and dimensional structure, and instrument
performance. Nonetheless, the thorough documentation of imaging experiments is significantly impaired by the
lack of community-sanctioned easy-to-use software tools to facilitate the extraction and collection of relevant
microscopy metadata. Here we present Micro-Meta App, an intuitive open-source software designed to tackle
these issues that was developed in the context of nascent global bioimaging community organizations, including
BioImaging North America (BINA) and QUAlity Assessment and REProducibility in Light Microscopy
(QUAREP-LiMi), whose goal is to improve reproducibility, data quality and sharing value for imaging
experiments. The App provides a user-friendly interface for building comprehensive descriptions of the
conditions utilized to produce individual microscopy datasets as specified by the recently proposed 4DN-BINA-
OME tiered-system of Microscopy Metadata model. To achieve this goal the App provides a visual guide for a
microscope-user to: 1) interactively build diagrammatic representations of hardware configurations of given
microscopes that can be easily reused and shared with colleagues needing to document similar instruments. 2)
Automatically extracts relevant metadata from image files and facilitates the collection of missing image
acquisition settings and calibration metrics associated with a given experiment. 3) Output all collected
Microscopy Metadata to interoperable files that can be used for documenting imaging experiments and shared
with the community. In addition to significantly lowering the burden of quality assurance, the visual nature of
Micro-Meta App makes it particularly suited for training users that have limited knowledge of the intricacies of
light microscopy experiments. To ensure wide-adoption by microscope-users with different needs Micro-Meta
App closely interoperates with MethodsJ2 and OMERO.mde, two complementary tools described in parallel
manuscripts.
.CC-BY-NC-ND 4.0 International licenseavailable under a
was not certified by peer review) is the author/funder, who has granted bioRxiv a license to display the preprint in perpetuity. It is made
The copyright holder for this preprint (whichthis version posted June 1, 2021. ; https://doi.org/10.1101/2021.05.31.446382doi: bioRxiv preprint
3
Background
The establishment of community-driven, shared documentation and quality control specifications for light
microscopy would allow to appropriately document imaging experiments, minimize errors and quantify any
residual uncertainty associated with each step of the procedure (1–6). In addition to providing essential
information about the provenance (i.e., origin, lineage) (7, 8) of microscopy results, this would make it possible
to faithfully interpret scientific claims, facilitate comparisons within and between experiments, foster
reproducibility, and maximize the likelihood that data can be re-used by other scientists for further insight (5, 6,
9, 10). First and foremost, such information would serve to facilitate the compilation of accurate Methods sections
for publications that utilize the quantitative power of microscopy experiments to answer scientific questions (11–
13). Furthermore, it would provide clear guidance to the manufacturers of microscopy instruments, hardware
components, and processing software about what information the scientific community requires to ensure
scientific rigor so that they can be automatically provided during acquisition and written in the headers of image
files. Last but not least, machine-actionable versions of the same information (14) could be provided alongside
image datasets on the growing number of public image data resources (3) that allow the deposition of raw image
data associated with scientific manuscripts, a promise to emulate for light microscopy the successful path that has
led to community standards in the field of genomics (15–19) (e.g., the IDR (20), EMPIAR (21), and Bioimage
Archive (22) hosted at the EMBL - EBI; the European Movincell (23); the Japanese SSBD hosted by RIKEN
(24); and, in the USA, the NIH-funded Cell Image Library (25, 26), BRAIN initiative’s imaging resources (27),
the Allen Cell Explorer (28), and the Human Cell Atlas (29–32)).
In order to promote the development of shared community-driven Microscopy Metadata standards, the NIH
funded 4D Nucleome (4DN) (33, 34) and the Chan Zuckerberg Initiative (CZI) funded BioImaging North
America (BINA) Quality Control and Data Management Working Group (QC-DM-WG) (35) have recently
proposed the 4DN-BINA-OME (NBO) a tiered-system for Microscopy Metadata specifications (36–39). The
4DN-BINA-OME specifications lay the foundations for upcoming community-sanctioned standards being
developed in the context of the Metadata Working Group (WG7) of the QUAlity Assessment and REProducibility
for Instrument and Images in Light Microscopy (QUAREP-LiMi) initiative (quarep.org) (4, 40). Their purpose is
to provide a scalable, interoperable and Open Microscopy Environment (OME) (41–43) Next-Generation File
Format (NGFF) (44) compatible framework for light microscopy metadata guiding scientists as to what
provenance metadata and calibration metrics should be provided to ensure the reproducibility of different
categories of imaging experiments.
Despite their value in indicating a path forward, guidelines, specifications, and standards on their own lack
the one essential feature that would make them actionable by experimental scientists faced with the challenge of
producing well-documented, high-quality, reproducible and re-usable datasets: namely easy-to-use software tools
or even better-automated pipelines to extract all available metadata from microscope configuration and image
data files.
While some advances have been proposed, such as OMERO.forms (45), PyOmeroUpload (46) and MethodsJ
(5), these tools only offer limited functionalities, are not integrated with community standards and are not per se
future proof. To provide a way forward, in this and in two related manuscripts, we present a suite of three
interoperable software tools (Supplemental Figure 1) that were developed to provide highly complementary,
intuitive approaches for the bench-side collection of Image Metadata, with particular reference to Experimental
Metadata and Microscopy Metadata (37, 38). In two related manuscripts, we describe: 1) OMERO.mde, which
is highly integrated with the widely used OMERO image data management repository and emphasizes the
.CC-BY-NC-ND 4.0 International licenseavailable under a
was not certified by peer review) is the author/funder, who has granted bioRxiv a license to display the preprint in perpetuity. It is made
The copyright holder for this preprint (whichthis version posted June 1, 2021. ; https://doi.org/10.1101/2021.05.31.446382doi: bioRxiv preprint
4
development of flexible, nascent specifications for experimental metadata (47–49); and 2) MethodsJ2 (50),
which is designed as an ImageJ plugin and emphasizes the consolidation of metadata from multiple sources and
automatic generation of Methods sections of scientific publications.
In this manuscript, we present Micro-Meta App (Figure 1), which works both as a stand-alone app on the
user’s desktop and as an integrated resource in third party web data portals. It offers a visual guide to navigate
through the different steps required for the rigorous documentation of imaging experiments (Figures 2-4) as
sanctioned by community specifications such as the 4DN-BINA-OME (NBO) Microscopy Metadata
specifications that were recently put forth to extend the OME Data Model (36–38, 51).
Methods: Implementation and Availability
Micro-Meta App is available in two JavaScript (JS) implementations. The first was designed to facilitate the
incorporation of the software in existing third party web portals (i.e., the 4DN Data Portal) (34, 52) and was
developed using the JavaScript React library, which is widely used to build web-based user interfaces. Starting
from this version, a stand-alone version of the App was developed by wrapping the React implementation using
the JavaScript Electron library, with the specific purpose of lowering the barrier of adoption of the tool by labs
that do not have access or prefer not to use imaging databases. More details about the implementation of Micro-
Meta App are available in Supplemental Material.
In order to promote the adoption of Micro-Meta App, incorporation in third party data portals and re-use of the
source code by other developers, the executables and source code for both Javascript React and Electron
implementations of Micro-Meta App are available on GitHub (53, 54). In addition, a website describing Micro-
Meta App (55) was developed alongside complete documentation and tutorials (56).
Results + Discussion
Micro-Meta App: an intuitive, highly visual interface to facilitate microscopy metadata collection
While the establishment of data formats, metadata standards and QC procedures is important, it is not per se
sufficient to make sure reporting and data quality guidelines are adopted by the community. To ensure their
routine utilization, it is, therefore, necessary to produce software tools that expedite QC procedures and image
data documentation and make it straightforward for investigators to reproduce results and make decisions
regarding the utility of specific datasets for addressing their specific questions. However, despite the availability
of the OME Data Model and Bioformats (41, 43), the lack of standards has resulted in a scarce adoption of
minimal information criteria and as a result the metadata provided by instrument and software manufacturers is
scarce (Supplemental Table I and II).
Micro-Meta App was developed to address this unmet need. Micro-Meta App consists of a Graphical User
Interface (GUI)-based open-source and interoperable software tool to facilitate and (when possible) automate the
annotation of fluorescence microscopy datasets. The App provides an interactive approach to navigate through
the different steps required for documenting light microscopy experiments based on available OME-compatible
community-sanctioned tiered systems of specifications. Thus, Micro-Meta App is not only capable of adapting to
varying levels of imaging complexity and user experience but also to evolving data models that might emerge
from the community. At the time of writing, the App implements the Core of the OME Data Model and the tiered
4DN-BINA-OME Basic extension (36–38, 51). Efforts to implement the current Confocal and Advanced as well
.CC-BY-NC-ND 4.0 International licenseavailable under a
was not certified by peer review) is the author/funder, who has granted bioRxiv a license to display the preprint in perpetuity. It is made
The copyright holder for this preprint (whichthis version posted June 1, 2021. ; https://doi.org/10.1101/2021.05.31.446382doi: bioRxiv preprint
5
as the Calibration and Performance 4DN-BINA-OME extensions are underway (see Future Directions). To
achieve this goal, Micro-Meta App is organized around two highly related data processing flows (Figure 1):
1) In the Manage Instrument modality, the App guides the users through the steps required to interactively build
a diagrammatic representation of a given Microscope (Figures 2A and 3) by dragging-and-dropping individual
components onto the workspace and entering the relevant attribute values based on the tier-level that best
suites the microscope modality, experimental design, instrument complexity, and image analysis needs (38).
2) From this, Micro-Meta App automatically generates structured descriptions of the microscope Hardware
Specifications and outputs them as interoperable Microscope.JSON files (example available on Zenodo as
illustrated in Supplemental Material) (57) that can be saved locally, used by existing third-party web-portals
(52), integrated with other software tools (MethodsJ2) and shared with other scientists, thus significantly
lowering the manual work required for rigorous record-keeping and enabling rapid uptake and widespread
implementation.
3) When user is ready to collect metadata to document the acquisition of specific image data sets, the Manage
Settings section of the App automatically imports Hardware Specifications metadata from previously-
prepared Microscope.JSON files and uses the BioFormats library (43) to extract available, OME-compatible
metadata from an image data file of interest. From this basis, the App interactively guides the user to enter
missing metadata specifying the tier-appropriate Settings used for a specific Image Acquisition session
(Figures 2B and 4).
4) As a final step, the App generates interoperable paired Microscope- and Settings- JSON files (example
available on Zenodo as illustrated in Supplemental Material) (57) that together contain comprehensive
documentation of the conditions utilized to produce individual microscopy datasets and can be stored locally
or integrated by third-party data portals (i.e., the 4D Nucleome Data Portal) (58).
Depending on the specific implementation of the Micro-Meta App being used (see Implementation section), the
workflow varies slightly. The discussion below refers specifically to the stand-alone version of Micro-Meta App
implemented in JavaScript Electron.
Manage Instrument Hardware
The purpose of this section of Micro-Meta App is to guide microscope users and custodians in the creation of
accurate but at the same time intuitive and easy-to-generate visual depictions of a given microscope. This is done
while collecting relevant information for each hardware component that scales with experimental intent,
instrument complexity and analytical needs of individual imaging experiments depending on tier-levels
sanctioned by the 4DN-BINA-OME Microscopy Metadata specifications (36–38, 51). Specifically, the workflow
(Figure 3) is composed of the following steps:
1) After launching the application, the user selects an appropriate Tier to be used (Figure 3A) to document a
given imaging experiment as determined by following the 4DN-BINA-OME tiered specifications (36–38,
51) and launches the Manage Instrument modality of Micro-Meta App by clicking the appropriate button
(Figure 3B). Because Micro-Meta App was specifically designed to be tier-aware, Micro-Meta App
automatically displays only metadata fields that are specified by 4DN-BINA-OME to belong to the tier that
was selected upon launching the App (Figure 3A), thus massively reducing the documentation burden. In
addition, to increase flexibility, the tier-level utilized for validation can be modified dynamically after
opening the main Manage Instrument workspace. This way, the user can, for example, be presented with all
Tier 2 appropriate fields while being required to only fill in Tier 1 fields for validation (see also point 3 ii).
.CC-BY-NC-ND 4.0 International licenseavailable under a
was not certified by peer review) is the author/funder, who has granted bioRxiv a license to display the preprint in perpetuity. It is made
The copyright holder for this preprint (whichthis version posted June 1, 2021. ; https://doi.org/10.1101/2021.05.31.446382doi: bioRxiv preprint