class: title-slide, middle, left ## Session 4: Data preparation and how to go from Luminex machine to [`covidClassifyR`](https://shaziaruybal.shinyapps.io/covidclassifyr) Shiny app ### Dr Shazia Ruybal-Pesántez Presented at the [covidClassifyR Shiny app workshop](https://shaziaruybal.github.io/covidClassifyR-workshop) for researchers from PNGIMR and partner institutions 2022-03-11 --- class: left # Recap -- ###
**[Session 1](https://shaziaruybal.github.io/covidClassifyR-workshop/sessions/2022-03-10-session1/index.html)** gave you an overview of the Luminex technology and the COVID-19 multi-antigen serological assay that was established in PNG -- ###
**Session 2** gave you an overview of the purpose of serosurveillance and insights into the COVID-19 sero-surveys that have been carried out in PNG -- ###
**[Session 3](https://shaziaruybal.github.io/covidClassifyR-workshop/sessions/2022-03-10-session3/index.html)** gave you an overview of the [`covidClassifyR`](https://shaziaruybal.shinyapps.io/covidclassifyr) Shiny app -- .footnote[ For all the workshop materials see the [workshop website
](https://shaziaruybal.github.io/covidClassifyR-workshop/materials.html) ] --- class: center #
# Today we will cover: -- ### How to prepare your raw data file and plate layout -- ### Do's and dont's -- ### Importing the raw data -- ### You can find the app [here
](https://shaziaruybal.shinyapps.io/covidClassifyR) --- class: inverse, middle, center #
## Preparing your data --- name: data-reqs # Raw data requirements #### Your raw data should be exported from the Luminex machine in .xlsx format -- #### Make sure that your sample labels in the Luminex machine protocol are as follows: - **Standards:** labels start with ‘S’ and then a number as required (e.g. S1, S2, S3 or Standard1, Standard2, Standard3) - **Blanks:** labels start with ‘B’ and then a number as required if there is more than one blank sample (.e.g ‘B1’, ‘B2’, or ‘Blank 1’, ‘Blank2’ etc). - **Unknown samples:** do not include individual sample labels, leave them as ‘Unknown’ -- **
Tip:** Label your antigens the same way in all plate runs. You can do this by setting up the protocol directly on the Luminex machine and using it for all your plate runs. -- **
Tip:** the Shiny app will interpret anything that starts with "S" as a Standard and will use the antibody data from these samples to calculate your standard curve. Similarly, it will interpret anything that starts with "B" as a Blank sample and anything else as an "Unknown". --- name: plate-reqs # Plate layout requirements #### Your plate layout should be in .xlsx format -- For each 96-well plate that you run on the Luminex machine, prepare a plate layout that includes the sample labels that will match your raw data. By supplying the plate layout, the Shiny application will match the raw data to the corresponding sample based on the plate layout that you import. -- Make sure that your sample labels in the plate layout are as follows: - **Standards:** labels start with ‘S’ and then a number as required (e.g. S1, S2, S3 or Standard1, Standard2, Standard3) - **Blanks:** labels start with ‘B’ and then a number as required if there is more than one blank sample (.e.g ‘B1’, ‘B2’, or ‘Blank 1’, ‘Blank2’ etc). - **Unknown samples:** label your unknown samples according to your specific sample codes (e.g. ABC001, ABC002) -- **
Tip:** make sure that there are no extra cells filled out other than the plate wells and sample names. -- **
Tip:** Use the example plate layout as a template to fill in with your sample details. -- **
Tip:** If you haven’t run a full plate, you can leave the wells with no samples completely blank (i.e. no labels). -- **
Tip:** Make sure that the word “Plate” is included in the first column, as the app expects this in order to determine the position of each sample and match it to the raw data outputs. --- class: inverse, middle, center #
## Download the example data [here
](https://shaziaruybal.shinyapps.io/covidClassifyR/_w_8c7cb1cd/example_data.zip) --- #
Example raw data .xlsx ![](img/egdata_screenshot.png) --- #
Example plate layout .xlsx ![](img/egplate_screenshot.png) --- #
Quiz -- ###
How do you need to label your standards? --
You need to label them starting with "S" -- ###
What would you do if you have more than one blank sample? --
Label them with sequential numbers (e.g. Blank1, Blank2, etc) -- ###
How do you need to label your unknown samples? --
You can use your study codes for each unknown samples --- class: inverse, middle, center #
## Importing your data --- #
Importing your data .panelset.sideways[ .panel[.panel-name[Navigate to the "Import data" tab] ![](img/import_screenshot.png) ] .panel[.panel-name[Experiment info] .pull-left[ <img src="img/import_buttons.png" width="350" height="400" /> ] .pull-right[ - Type directly in the text box to change the experiment name that best describes your particular data/Luminex run. For example, you can label it as “MyExperimentName_Plate01”. - The analysis date will default to today’s date, but you can modify this by clicking on the date and selecting the date in the calendar. - You can also insert experiment notes to provide more details or notes, as necessary. These notes will be displayed on your quality control report when you download it. **
Tip: ** Try to keep your experiment name/filename free of spaces and instead use “_” or “-”. All of your downloadable files (processed data, quality control report, etc) will be labeled as “experiment1_2022-03-06”. ] ] .panel[.panel-name[Change the experiment info] <video width="1330" height="410" controls> <source src="screen_records/edit_import.mp4" type="video/mp4"> </video> ] .panel[.panel-name[Upload your files] .pull-left[ <img src="img/import_uploaded_data.png" width="350" height="400" /> ] .pull-right[ Use the browse button to navigate to your files and upload them. **
Tip: ** The bar should look blue when the upload is successful. If you get an error, make sure you are uploading .xlsx files. ]] ] --- #
Voila! <video width="1330" height="410" controls> <source src="screen_records/upload_files.mp4" type="video/mp4"> </video> --- # Check the raw data .pull-left[ ### You will notice that the “Check the raw data” tab has populated with a preview of your raw data file.
Check whether it looks as expected. You can scroll as needed.
Check that the raw data file you uploaded was the correct one, by looking at the “Raw data filename” directly under the tab. If it is the wrong one you can click on “Browse” again and upload the correct file. ] .pull-right[ ![](img/check_raw_data.png) ] --- # Check the run info .pull-left[ ### You can use the “Check the run info” tab to only look at run specifications and check that they are expected.
Check that the Batch, ProtocolName and sample volume are correct and labeled as you expect them to be ] .pull-right[ ![](img/check_run_info.png) ] --- # Check the plate layout .pull-left[ You can use the “Check the plate layout” tab to make sure the plate layout looks as expected. It is very important to make sure your samples are labeled correctly so that they are interpreted correctly by the app.
Check that the plate layout file you uploaded was the correct one, by looking at the “Plate layout filename” directly under the tab. If it is the wrong one you can click on “Browse” again and upload the correct file.
Make sure that there are no extra cells filled out other than the plate wells and sample names. ] .pull-right[ ![](img/check_plate.png) ] --- #
Demo <video width="1330" height="410" controls> <source src="screen_records/import_data_demo.mp4" type="video/mp4"> </video> --- class: inverse, middle, center #
## Next session: ### Quality control of your data --- # Acknowledgments - Dr Maria Ome-Kaius and Dr Fiona Angrisano - PNGIMR and partner institutions - WEHI & Burnet Institute - All of you for attending! *We are extremely grateful for financial support to develop and host the covidClassifyR Shiny web application, and to host these virtual workshops through the [Regional Collaborations Programme COVID-19 Digital Grant](https://www.science.org.au/news-and-events/news-and-media-releases/regional-research-set-get-digital-boost) from the Australian Academy of Science and Australian Department of Industry, Science, Energy and Resources.* The scripts and functions used in [`covidClassifyR`](https://shaziaruybal.shinyapps.io/covidclassifyr) were developed by Shazia Ruybal-Pesántez, with contributions from the following researchers: Eamon Conway, Connie Li Wan Suen, Narimane Nekkab and Michael White. .footnote[ _These slides were created using the R packages: [xaringan](https://github.com/yihui/xaringan), [xaringanthemer](https://github.com/gadenbuie/xaringanthemer), [xaringanExtra](https://github.com/gadenbuie/xaringanExtra)_ ] --- name: contact class: inverse .pull-left[ .center[ ### Dr Shazia Ruybal-Pesántez <img style="border-radius: 50%;" src="https://shaziaruybal.github.io/covidClassifyR-workshop/images/shazia.png" width="250px"/> #### Contact details [
ruybal.s@wehi.edu.au](mailto:ruybal.s@wehi.edu.au) [
@DrShaziaRuybal](https://twitter.com/DrShaziaRuybal) ]] .pull-right[ ### Session 4 Resources: ### [
Recording](https://youtu.be/G4etCejNviA) ### [
`covidClassifyR`](https://shaziaruybal.shinyapps.io/covidClassifyR) ### [
Workshop materials](https://shaziaruybal.github.io/covidClassifyR-workshop/materials.html) ### [
Slides for Session 4](https://shaziaruybal.github.io/covidClassifyR-workshop/slides/session4/session4_slides.html) ] --- class: inverse, middle, center #
Questions?