Skip to content

DavidRach/InstrumentQC_Install

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

41 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GPL-3.0 CC BY-SA 4.0

InstrumentQC

Having reached this webpage, you likely discovered the InstrumentQC website I implemented at the University of Maryland, Baltimore to track daily QC for the Cytek and BD instruments. I am providing this documentation for those of you who would like to understand how it is implemented, whether for curiosity or because you'd like to modify the code to set up something similar for your own cytometers.

Having placed significant effort into this pet-project, I would love if others in the cytometery community could also benefit. Since assembling everything from scratch requires some familiarity with both R and Git, I am writing up this detailed explanation of the process behind setting up and customizing the dashboards to give the average cytometry aficionado a fighting-chance.

To get started, navigate to the walk-through explanation website by clicking here

If you get stuck, or parts of the documentation are unclear, please reach out by opening a discussion and I will try my best to help you troubleshoot. What makes free-and-open source software great (and in my opinion,fun to work with) is seeing how the small collective contributions of users improve the projects over time.

Best- David

High-level Overview

After daily QC is run on a Cytek instrument, the relevant information is stored as .fcs and .csv files in specific folders. Using functions incorporated in the Luciernaga R package, the data associated with these newly generated files is processed using R once a day at a user-designated time (implemented via Windows Task Sceduler). The version control software Git keeps track of changes to the processed data, passing updates to the online GitHub repository for storage. This data is then referenced when building the dashboard website using Quarto, which is published as a GitHub page allowing for url access.

For multiple instruments, the above process is repeated on each instruments computer, and the Quarto webpages are modified to display data from each instrument.

Contributing

Trying to implement this on your end and encountering issues? Glad to help, please open a new discussion

Encountered a bug and want to report it? Found a glaring typo in my pre-morning coffee English? I always appreciate the help, please open a new issue and I will work on fixing/editing when I get a chance.

GPL-3.0 CC BY-SA 4.0

This material is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. The code examples are licensed under the GNU GENERAL PUBLIC LICENSE (GPL-3.0)

About

Installation how-to for the InstrumentQC dashboard

Resources

License

GPL-3.0, CC-BY-SA-4.0 licenses found

Licenses found

GPL-3.0
LICENSE.txt
CC-BY-SA-4.0
LICENSE_CC-BY-SA.txt

Stars

Watchers

Forks

Languages