Merge pull request #400 from LabKey/fb_merge_25.7_to_develop

bbimber · web-flow · commit 4e696012d6a9 · 2025-11-24T16:30:11.000-08:00
Merge 25.7 to develop
diff --git a/SequenceAnalysis/pipeline_code/extra_tools_install.sh b/SequenceAnalysis/pipeline_code/extra_tools_install.sh
@@ -333,3 +333,20 @@ then
 else
     echo "Already installed"
 fi
+
+
+if [[ ! -e ${LKTOOLS_DIR}/primer3_core || ! -z $FORCE_REINSTALL ]];
+then
+    echo "Cleaning up previous installs"
+    rm -Rf $LKTOOLS_DIR/primer3_core*
+    rm -Rf primer3*
+    rm -Rf v2.6.1.tar.gz
+
+    wget https://github.com/primer3-org/primer3/archive/refs/tags/v2.6.1.tar.gz
+    tar -xf v2.6.1.tar.gz
+    cd primer3-2.6.1/src
+    make
+    install primer3_core $LKTOOLS_DIR/
+else
+    echo "Already installed"
+fi
diff --git a/SequenceAnalysis/src/org/labkey/sequenceanalysis/run/preprocessing/TagPcrSummaryStep.java b/SequenceAnalysis/src/org/labkey/sequenceanalysis/run/preprocessing/TagPcrSummaryStep.java
@@ -72,7 +72,7 @@ public Provider()
                         put("checked", true);
                     }}, true),
                     ToolParameterDescriptor.createCommandLineParam(CommandLineParam.create("--insert-name"), "insertType", "Insert Type", "The type of insert to detect.", "ldk-simplecombo", new JSONObject(){{
-                        put("storeValues", "PiggyBac;Lentivirus;PREDICT");
+                        put("storeValues", "PiggyBac;Lentivirus;PREDICT;BxBI_attP");
                         put("allowBlank", false);
                     }}, null),
                     ToolParameterDescriptor.create(DESIGN_PRIMERS, "Design Primers", "If selected, Primer3 will be used to design primers to flank integration sites", "checkbox", new JSONObject(){{
diff --git a/Studies/resources/queries/studies/studyCohorts/.qview.xml b/Studies/resources/queries/studies/studyCohorts/.qview.xml
@@ -0,0 +1,22 @@
+<customView xmlns="http://labkey.org/data/xml/queryCustomView" hidden="false" canOverride="false">
+    <columns>
+        <column name="rowId"/>
+        <column name="studyId"/>
+        <column name="studyId/description">
+            <properties>
+                <property name="columnTitle" value="Study Description"/>
+            </properties>
+        </column>
+        <column name="cohortName"/>
+        <column name="label"/>
+        <column name="category"/>
+        <column name="description"/>
+        <column name="isControlGroup"/>
+        <column name="sortOrder"/>
+    </columns>
+    <sorts>
+        <sort column="studyId/studyName" descending="false"/>
+        <sort column="sortOrder" descending="false"/>
+        <sort column="cohortName" descending="false"/>
+    </sorts>
+</customView>
diff --git a/Studies/resources/schemas/dbscripts/postgresql/studies-23.005-23.006.sql b/Studies/resources/schemas/dbscripts/postgresql/studies-23.005-23.006.sql
@@ -0,0 +1 @@
+ALTER TABLE studies.subjectAnchorDates ADD COLUMN sourceRecord varchar(1000);
diff --git a/Studies/resources/schemas/dbscripts/sqlserver/studies-23.005-23.006.sql b/Studies/resources/schemas/dbscripts/sqlserver/studies-23.005-23.006.sql
@@ -0,0 +1 @@
+ALTER TABLE studies.subjectAnchorDates ADD sourceRecord varchar(1000);
diff --git a/Studies/resources/schemas/studies.xml b/Studies/resources/schemas/studies.xml
@@ -526,6 +526,10 @@
                     <fkDisplayColumnName>label</fkDisplayColumnName>
                 </fk>
             </column>
+            <column columnName="sourceRecord">
+                <columnTitle>Source Record</columnTitle>
+                <isHidden>true</isHidden>
+            </column>
             <column columnName="dataSource">
                 <columnTitle>Data Source</columnTitle>
             </column>
diff --git a/Studies/src/org/labkey/studies/StudiesModule.java b/Studies/src/org/labkey/studies/StudiesModule.java
@@ -34,7 +34,7 @@ public String getName()
     @Override
     public @Nullable Double getSchemaVersion()
     {
-        return 23.005;
+        return 23.006;
     }
 
     @Override
diff --git a/Studies/src/org/labkey/studies/query/StudiesTriggerFactory.java b/Studies/src/org/labkey/studies/query/StudiesTriggerFactory.java
@@ -93,6 +93,11 @@ private void possiblyResolveStudyOrCohort(String tableToQuery, @Nullable Map<Str
                 return;
             }
 
+            if (row.get(sourceProperty) instanceof Integer)
+            {
+                return;
+            }
+
             if (row.get(sourceProperty) != null & row.get(sourceProperty) instanceof String & !String.valueOf(row.get(sourceProperty)).isEmpty())
             {
                 if (!NumberUtils.isCreatable(row.get(sourceProperty).toString()))
diff --git a/singlecell/resources/chunks/StudyMetadata.R b/singlecell/resources/chunks/StudyMetadata.R
@@ -32,7 +32,7 @@ for (datasetId in names(seuratObjects)) {
         seuratObj <- Rdiscvr::ApplyEC_Metadata(seuratObj, errorIfUnknownIdsFound = errorIfUnknownIdsFound)
     } else if (studyName == 'PPG_Stims') {
         seuratObj <- Rdiscvr::ApplyPPG_Stim_Metadata(seuratObj, errorIfUnknownIdsFound = errorIfUnknownIdsFound)
-    ] else if (studyName == 'IMPAC_TB_Human') {
+    } else if (studyName == 'IMPAC_TB_Human') {
         seuratObj <- Rdiscvr::ApplyIMPAC_TB_Human_Metadata(seuratObj, errorIfUnknownIdsFound = errorIfUnknownIdsFound)
     } else {
         stop(paste0('Unknown study: ', studyName))
diff --git a/singlecell/src/org/labkey/singlecell/run/CellRangerGexCountStep.java b/singlecell/src/org/labkey/singlecell/run/CellRangerGexCountStep.java
@@ -5,6 +5,7 @@
 import org.apache.commons.io.FileUtils;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.tuple.Pair;
+import org.apache.logging.log4j.Logger;
 import org.jetbrains.annotations.Nullable;
 import org.json.JSONObject;
 import org.labkey.api.collections.CaseInsensitiveHashMap;
@@ -47,15 +48,19 @@
 import org.labkey.api.writer.PrintWriters;
 import org.labkey.singlecell.SingleCellSchema;
 
+import java.io.BufferedReader;
 import java.io.File;
 import java.io.IOException;
+import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public class CellRangerGexCountStep extends AbstractAlignmentPipelineStep<CellRangerWrapper> implements AlignmentStep
 {
@@ -613,4 +618,88 @@ public void complete(SequenceAnalysisJobSupport support, AnalysisModel model, Co
             }
         }
     }
+
+    public enum Chemistry
+    {
+        // See: https://kb.10xgenomics.com/s/article/115004506263-What-is-a-barcode-inclusion-list-formerly-barcode-whitelist
+        // cellranger-x.y.z/lib/python/cellranger/barcodes/
+        FivePE_V3("Single Cell 5' PE v3", "3M-5pgex-jan-2023.txt.gz"),
+        FivePE_V2("Single Cell 5' PE v2", "737k-august-2016.txt");
+
+        final String _label;
+        final String _inclusionListFile;
+
+        Chemistry(String label, String inclusionListFile)
+        {
+            _label = label;
+            _inclusionListFile = inclusionListFile;
+        }
+
+        public File getInclusionListFile(Logger logger) throws PipelineJobException
+        {
+            File exe = new CellRangerWrapper(logger).getExe();
+            if (Files.isSymbolicLink(exe.toPath()))
+            {
+                try
+                {
+                    exe = Files.readSymbolicLink(exe.toPath()).toFile();
+                }
+                catch (IOException e)
+                {
+                    throw new PipelineJobException(e);
+                }
+            }
+
+            File il = new File(exe.getParentFile(), "lib/python/cellranger/barcodes/" + _inclusionListFile);
+            if (!il.exists())
+            {
+                throw new PipelineJobException("Unable to find file: " + il.getPath());
+            }
+
+            return il;
+        }
+
+        public static Chemistry getByLabel(String label)
+        {
+            for (Chemistry c : Chemistry.values())
+            {
+                if (c._label.equals(label))
+                {
+                    return c;
+                }
+            }
+
+            throw new IllegalArgumentException("Unknown chemistry: " + label);
+        }
+    }
+
+    public static Chemistry inferChemistry(File cloupeFile) throws PipelineJobException
+    {
+        File html = new File(cloupeFile.getPath().replaceAll("_cloupe.cloupe$", "_web_summary.html"));
+        if (!html.exists())
+        {
+            throw new IllegalArgumentException("Missing file: " + html.getPath());
+        }
+
+        final Pattern pattern = Pattern.compile("\\[\"Chemistry\",\"(.*?)\"],");
+        try (BufferedReader reader = Readers.getReader(html))
+        {
+            String line;
+            while ((line = reader.readLine()) != null)
+            {
+                Matcher m = pattern.matcher(line);
+                if (m.find())
+                {
+                    String chem = m.group(1);
+                    return Chemistry.getByLabel(chem);
+                }
+            }
+        }
+        catch (IOException e)
+        {
+            throw new PipelineJobException(e);
+        }
+
+        throw new IllegalArgumentException("Unable to infer chemistry for file: " + html.getPath());
+    }
 }
diff --git a/singlecell/src/org/labkey/singlecell/run/NimbleAlignmentStep.java b/singlecell/src/org/labkey/singlecell/run/NimbleAlignmentStep.java
@@ -86,10 +86,10 @@ public AlignmentOutput performAlignment(Readset rs, List<File> inputFastqs1, @Nu
         AlignmentOutputImpl output = new AlignmentOutputImpl();
 
         boolean throwIfNotFound = getProvider().getParameterByName(REQUIRE_CACHED_BARCODES).extractValue(getPipelineCtx().getJob(), getProvider(), getStepIdx(), Boolean.class, false);
-        File cachedBarcodes = getCachedBarcodeFile(rs, throwIfNotFound);
+        File loupeFile = getCachedLoupeFile(rs, throwIfNotFound);
 
         File localBam;
-        if (cachedBarcodes == null)
+        if (loupeFile == null)
         {
             localBam = performCellRangerAlignment(output, rs, inputFastqs1, inputFastqs2, outputDirectory, referenceGenome, basename, readGroupId, platformUnit);
         }
@@ -109,15 +109,15 @@ public AlignmentOutput performAlignment(Readset rs, List<File> inputFastqs1, @Nu
 
     private File createNimbleBam(AlignmentOutputImpl output, Readset rs, List<File> inputFastqs1, List<File> inputFastqs2) throws PipelineJobException
     {
-        File cellBarcodeUmiMap = getCachedBarcodeFile(rs, true);
+        File loupeFile = getCachedLoupeFile(rs, true);
 
-        return NimbleHelper.runFastqToBam(output, getPipelineCtx(), rs, inputFastqs1, inputFastqs2, cellBarcodeUmiMap);
+        return NimbleHelper.runFastqToBam(output, getPipelineCtx(), rs, inputFastqs1, inputFastqs2, loupeFile);
     }
 
-    private File getCachedBarcodeFile(Readset rs, boolean throwIfNotFound) throws PipelineJobException
+    private File getCachedLoupeFile(Readset rs, boolean throwIfNotFound) throws PipelineJobException
     {
-        Map<Integer, Integer> map = getPipelineCtx().getSequenceSupport().getCachedObject(CACHE_KEY, PipelineJob.createObjectMapper().getTypeFactory().constructParametricType(Map.class, Integer.class, Integer.class));
-        Integer dataId = map.get(rs.getReadsetId());
+        Map<Long, Long> map = getPipelineCtx().getSequenceSupport().getCachedObject(CACHE_KEY, PipelineJob.createObjectMapper().getTypeFactory().constructParametricType(Map.class, Long.class, Long.class));
+        Long dataId = map.get(rs.getReadsetId());
         if (dataId == null)
         {
             if (throwIfNotFound)
@@ -137,14 +137,14 @@ private File getCachedBarcodeFile(Readset rs, boolean throwIfNotFound) throws Pi
         return ret;
     }
 
-    private ExpData findCellBarcodeFiles(Readset rs) throws PipelineJobException
+    private ExpData findLoupeFile(Readset rs) throws PipelineJobException
     {
         Container targetContainer = getPipelineCtx().getJob().getContainer().isWorkbookOrTab() ? getPipelineCtx().getJob().getContainer().getParent() : getPipelineCtx().getJob().getContainer();
         UserSchema us = QueryService.get().getUserSchema(getPipelineCtx().getJob().getUser(), targetContainer, SingleCellSchema.SEQUENCE_SCHEMA_NAME);
         TableInfo ti = us.getTable("outputfiles");
 
         SimpleFilter sf = new SimpleFilter(FieldKey.fromString("readset"), rs.getRowId());
-        sf.addCondition(FieldKey.fromString("category"), NimbleHelper.CATEGORY_CB);
+        sf.addCondition(FieldKey.fromString("category"), CellRangerGexCountStep.LOUPE_CATEGORY);
         List<Integer> cbs = new TableSelector(ti, PageFlowUtil.set("dataid"), sf, new Sort("-rowid")).getArrayList(Integer.class);
         if (!cbs.isEmpty())
         {
@@ -199,19 +199,19 @@ public void init(SequenceAnalysisJobSupport support) throws PipelineJobException
         }
 
         // Try to find 10x barcodes:
-        HashMap<Long, Long> readsetToBarcodes = new HashMap<>();
+        HashMap<Long, Long> readsetToLoupe = new HashMap<>();
         for (Readset rs : support.getCachedReadsets())
         {
-            ExpData f = findCellBarcodeFiles(rs);
+            ExpData f = findLoupeFile(rs);
             if (f != null)
             {
                 support.cacheExpData(f);
-                readsetToBarcodes.put(rs.getReadsetId(), f.getRowId());
+                readsetToLoupe.put(rs.getReadsetId(), f.getRowId());
             }
         }
 
-        support.cacheObject(CACHE_KEY, readsetToBarcodes);
+        support.cacheObject(CACHE_KEY, readsetToLoupe);
     }
 
-    private static final String CACHE_KEY = "nimble.cb";
+    private static final String CACHE_KEY = "nimble.loupe";
 }
diff --git a/singlecell/src/org/labkey/singlecell/run/NimbleHelper.java b/singlecell/src/org/labkey/singlecell/run/NimbleHelper.java
@@ -594,7 +594,7 @@ private static File getNimbleDoneFile(File parentDir, String resumeString)
         return new File(parentDir, "nimble." + resumeString + ".done");
     }
 
-    public static File runFastqToBam(PipelineStepOutput output, PipelineContext ctx, Readset rs, List<File> inputFastqs1, List<File> inputFastqs2, File cellBarcodeUmiMap) throws PipelineJobException
+    public static File runFastqToBam(PipelineStepOutput output, PipelineContext ctx, Readset rs, List<File> inputFastqs1, List<File> inputFastqs2, File loupeFile) throws PipelineJobException
     {
         List<File> outputBams = new ArrayList<>();
         int bamIdx = 0;
@@ -627,7 +627,8 @@ public static File runFastqToBam(PipelineStepOutput output, PipelineContext ctx,
             args.add(inputFastqs2.get(bamIdx).getPath());
 
             args.add("--map");
-            args.add(cellBarcodeUmiMap.getPath());
+            CellRangerGexCountStep.Chemistry chem = CellRangerGexCountStep.inferChemistry(loupeFile);
+            args.add(chem.getInclusionListFile(ctx.getLogger()).getPath());
 
             args.add("--output");
             args.add(outputBam.getPath());

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+ALTER TABLE studies.subjectAnchorDates ADD COLUMN sourceRecord varchar(1000);`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public String getName()`
`34`	`34`	`@Override`
`35`	`35`	`public @Nullable Double getSchemaVersion()`
`36`	`36`	`{`
`37`		`- return 23.005;`
	`37`	`+ return 23.006;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -93,6 +93,11 @@ private void possiblyResolveStudyOrCohort(String tableToQuery, @Nullable Map<Str`
`93`	`93`	`return;`
`94`	`94`	`}`
`95`	`95`
	`96`	`+ if (row.get(sourceProperty) instanceof Integer)`
	`97`	`+ {`
	`98`	`+ return;`
	`99`	`+ }`
	`100`	`+`
`96`	`101`	`if (row.get(sourceProperty) != null & row.get(sourceProperty) instanceof String & !String.valueOf(row.get(sourceProperty)).isEmpty())`
`97`	`102`	`{`
`98`	`103`	`if (!NumberUtils.isCreatable(row.get(sourceProperty).toString()))`