Releases: broadinstitute/carmen-analysis
v5.4.2
v5.4.1
v5.4.0
Highlights of the 5.4.0 release
Previously, there was an issue when analyzing runs combining assays from RVP with BBP Panel 1 and Panel 2 assays. This version has resolved this issue.
Previously, there was an issue with plotting heatmaps with duplicate assays and fewer than 192 samples (i.e. duplicated samples). This version has resolved this issue wherein the median of duplicated assays’ data is taken for the same sample. Additionally, heatmaps are now successfully generated with a (1x1) format.
Updated installation requirements:
To generate the Redcap file necessary for data storage at clinical partner sites, you must add the command-line argument REDCAP
to the end of your run command. For example, on a macOS system, this would be:
-
python3 analyze_run.py 1.8_Mean REDCAP
-
python3 analyze_run.py 3_SD REDCAP
The Redcap file will be generated in the RESULTS sub-folder within the output folder.
To most accurately capture the assay and sample invalidity status in the RESULTS Excel file and the REDCAP file, it is recommended that you name assays exactly as listed below (case-insensitive, but underscores and dashes must match):
-
BBP P1 assays:
CCHFV
,EBOV
,HIV_1
,HIV_2
,LASV
,MBV
,MPOX_DNA
,PF_3_DNA
,WNV
,YFV
,RNASEP_P1
-
BBP P2 assays:
CHI
,DENV
,HBV_DNA
,HCV
,HTV
,MMV
,ONN
,RBV
,RVFV
,SYPH_DNA
,ZIKV
,NPV
,RNASEP_P2
-
RVP assays:
SARS_COV-2
,HCOV_HKU1
,HCOV_NL63
,HCOV_OC43
,FLUAV
,FLUBV
,HMPV
,HRSV
,HPIV_3
,RNASEP_RVP
-
Control assay:
no_crRNA
To generate accurate assay performance evaluations, it is recommended that sample names must end with _RVP, _P1, or _P2, corresponding to the panels for which you hope to test the sample against.
v5.3.0
v5.2.2
v5.2.1
v5.2.0
Highlights of the 5.2.0 release
- This release has resolved the following issues with the formatting of the REDCAP file:
- The date is now compiled as DD/MM/YYYY.
- The contaminated NTC check now correctly codes NTC samples with background fluorescence signal greater than 0.5 a.u as a 6 in the REDCAP file.
- Positive samples are coded as 1 not 1.0.
- The merging of the same sample ran on different panels is now done by verifying which panel the viral assay belongs to.
v5.1.1
v5.1.0
Highlights of the 5.1.0 release
- Add REDCAP as an additional command line argument when running the code, if you are interested in generating the REDCAP. For example, python3 -i analyze_run.py 3_SD REDCAP
- Metadata formatting is now added into the REDCAP csv file
- The ‘Assay Valid?’ row is added to all files, with VALID or INVALID as the cell value. Previously, this row was only appended to the RESULTS Excel file if there were invalid assays.