Kdn adding and diagnostic filtering

MetaMorpheus/EngineLayer/EngineLayer.csproj

@@ -62,6 +62,9 @@
     <None Update="Glycan_Mods\OGlycan\OGlycan.gdb">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>
+    <None Update="Glycan_Mods\OGlycan\OGlycan_withIsobaric.gdb">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
     <None Update="Glycan_Mods\OGlycan\Olgycan Database 28 glycans plus Sodium 56 total.txt">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </None>

MetaMorpheus/EngineLayer/Glycan_Mods/OGlycan/OGlycan_withIsobaric.gdb

@@ -0,0 +1,13 @@
+(N)
+(N(H))
+(N(A))
+(N(H)(N))
+(N(H(A)))
+(N(N(K)))
+(N(H)(N(H)))
+(N(H(A))(N))
+(N(H(A))(A))
+(N(H(A))(N(H)))
+(N(H)(N(H(A))(F)))
+(N(H(A))(N(H(A))))
+(N(H(A))(N(H(A))(F)))

MetaMorpheus/EngineLayer/GlycoSearch/AdjNode.cs

@@ -4,6 +4,7 @@
 
 namespace EngineLayer.GlycoSearch
 {
+    //the class is for localization graph matrix. Each node in the matrix is represented by AdjNode.
     public class AdjNode
     {
         //AdjNode -> Adjactent node is used to build graph matrix for localizaiton. Each node in graph matrix contain Sources, max cost, current cost, etc.

MetaMorpheus/EngineLayer/GlycoSearch/GlycanBox.cs

@@ -9,20 +9,25 @@
 
 namespace EngineLayer
 {
-    //One peptide can have several o-glycans. The combined glycans are grouped as a glycan box. Used for localization. 
-    //GlycanBox -- A defined combination of glycans will be considered to modify on one peptide. 
-    //The GlycanBoxMass is the total mass of all glycans on the peptide
+
+    /// <summary>
+    /// A defined combination of glycans to modify on one peptide. Ex. if we have 3 glycans on one peptide (g1,g2,g3), the GlycanBoxMass is the sum of the three glycans.(glycanBox: [g1,g2,g3])
+    /// </summary>
     public class GlycanBox:ModBox
     {
-        public static Glycan[] GlobalOGlycans { get; set; }
+        public static Glycan[] GlobalOGlycans { get; set; } // The glycan list in the database file
+
+        public GlycanBox[] ChildGlycanBoxes { get; set; }   // all possible glycan combinations in the glycanBox
 
         public static Modification[] GlobalOGlycanModifications { get; set; }
 
-        public static GlycanBox[] OGlycanBoxes { get; set; }
+        public static GlycanBox[] OGlycanBoxes { get; set; } // all possible glycan boxes
+
+        public byte[] Kind { get; private set; } 
 
         //TO DO: Decoy O-glycan can be created, but the results need to be reasoned.
         //public static int[] SugarShift = new int[]{ -16205282, -20307937, -29109542, -14605791, -30709033, -15005282, -36513219, -40615874, 16205282, 20307937, 29109542, 14605791, 30709033, 15005282, 36513219, 40615874 };
-        private readonly static int[] SugarShift = new int[] 
+        private readonly static int[] SugarShift = new int[] //still unclear about the shift...
         {
             7103710, 10300920, 11502690, 12904260, 14706840, 5702150, 13705890, 12809500, 11308410, 13104050,
             11404290, 9705280, 12805860, 15610110, 8703200, 10104770, 9906840, 18607930, 16306330,
@@ -31,7 +36,11 @@ public class GlycanBox:ModBox
 
         };
 
-        //After O-glycans are read in from database, we build combinations of glycans into GlycanBox. The maxNum is maximum glycans allowed on one peptides.
+        /// <summary>
+        /// Use the glycan from database to create all possible combination glycan set into GlycanBox. 
+        /// </summary>
+        /// <param name="maxNum"> The maxNum is maximum glycans allowed on one peptides </param>
+        /// <returns> The glycanBox collection, glycanBox[]</returns>
         public static IEnumerable<GlycanBox> BuildOGlycanBoxes(int maxNum)
         {
             return BuildOGlycanBoxes(maxNum, false);
@@ -51,7 +60,7 @@ public static IEnumerable<GlycanBox> BuildOGlycanBoxes(int maxNum, bool buildDec
 
                     if (buildDecoy)
                     {
-                        GlycanBox glycanBox_decoy = new GlycanBox(idCombine.ToArray());
+                        GlycanBox glycanBox_decoy = new GlycanBox(idCombine.ToArray(),false); // decoy glycanBox
                         glycanBox_decoy.TargetDecoy = false;
                         glycanBox_decoy.ChildGlycanBoxes = BuildChildOGlycanBoxes(glycanBox_decoy.NumberOfMods, glycanBox_decoy.ModIds, glycanBox_decoy.TargetDecoy).ToArray();
                         yield return glycanBox_decoy;
@@ -60,8 +69,11 @@ public static IEnumerable<GlycanBox> BuildOGlycanBoxes(int maxNum, bool buildDec
             }
         }
 
-        //After O-glycans are read in from database, we transfer the glycans into 'Modification' class type for MetaMorpheus to manipulate sequences.
-        //In the future we may able to combine the two type together. 
+        /// <summary>
+        /// Convert the glycan into Modification type for MetaMorpheus to manipulate sequences. In the future we may able to combine the two type together.
+        /// </summary>
+        /// <param name="globalOGlycans"></param>
+        /// <returns></returns>
         public static Modification[] BuildGlobalOGlycanModifications(Glycan[] globalOGlycans)
         {
             Modification[] globalOGlycanModifications = new Modification[globalOGlycans.Length];
@@ -73,20 +85,26 @@ public static Modification[] BuildGlobalOGlycanModifications(Glycan[] globalOGly
             return globalOGlycanModifications;
         }
 
-        //The function here is to build GlycanBoxes used for LocalizationGraph. 
-        //In LocalizationGraph matrix, for each AdjNode, it represent a ChildOGlycanBox here at certain glycosite.
+
+        /// <summary>
+        /// Generate all possible child/fragment box of the specific glycanBox. The childBoxes is uesd for LocalizationGraph.
+        /// </summary>
+        /// <param name="maxNum"></param>
+        /// <param name="glycanIds"> The glycanBox, ex. [0,0,1] means glycan0 + glycan0 + glycan1 </param>
+        /// <param name="targetDecoy"></param>
+        /// <returns> The ChildBox collection, ChildBox[] </returns>
         public static IEnumerable<GlycanBox> BuildChildOGlycanBoxes(int maxNum, int[] glycanIds, bool targetDecoy = true)
         {
             yield return new GlycanBox(new int[0], targetDecoy);
             HashSet<string> seen = new HashSet<string>();
             for (int i = 1; i <= maxNum; i++)
             {
-                foreach (var idCombine in Glycan.GetKCombs(Enumerable.Range(0, maxNum), i))
-                {
-                    List<int> ids = new List<int>();
-                    foreach (var id in idCombine)
+                foreach (var idCombine in Glycan.GetKCombs(Enumerable.Range(0, maxNum), i)) //get all combinations of glycans on the peptide, ex. we have three glycosite and three glycan maybe on that (A,B,C) 
+                {                                                                           //the combination of glycans on the peptide can be (A),(A+B),(A+C),(B+C),(A+B+C) totally six 
+                    List<int> ids = new List<int>(); 
+                    foreach (var id in idCombine)    
                     {
-                        ids.Add(glycanIds[id]);
+                        ids.Add(glycanIds[id]);      
                     }
 
                     if (!seen.Contains(string.Join(",", ids.Select(p => p.ToString()))))
@@ -102,19 +120,24 @@ public static IEnumerable<GlycanBox> BuildChildOGlycanBoxes(int maxNum, int[] gl
             }
         }
 
-        public GlycanBox(int[] ids, bool targetDecoy = true):base(ids)
+        /// <summary>
+        /// Constructor of GlycanBox.
+        /// </summary>
+        /// <param name="ids"> The glycanBox composition, each number represent one glycan index in the database</param>
+        /// <param name="targetDecoy"></param>
+        public GlycanBox(int[] ids, bool Istarget = true):base(ids)
         {
-            byte[] kind = new byte[] { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
-            foreach (var id in ModIds)
+            byte[] kind = new byte[] { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 };
+            foreach (var id in ModIds) //ModIds is the same as ids.
             {
-                for (int i = 0; i < kind.Length; i++)
+                for (int i = 0; i < kind.Length; i++)   
                 {
-                    kind[i] += GlobalOGlycans[id].Kind[i];
+                    kind[i] += GlobalOGlycans[id].Kind[i]; //kind is the sum of all glycan Kind in the Box.
                 }
             }
             Kind = kind;
 
-            if (targetDecoy)
+            if (Istarget)
             {
                 Mass = (double)Glycan.GetMass(Kind) / 1E5;
             }
@@ -125,18 +148,13 @@ public GlycanBox(int[] ids, bool targetDecoy = true):base(ids)
                 Mass = (double)(Glycan.GetMass(Kind) + SugarShift[shiftInd]) / 1E5;
             }
         }
-
-        public GlycanBox[] ChildGlycanBoxes { get; set; }
-
-        public string GlycanIdString
+
+        public string GlycanIdString // the composition of glycanBox. Example: [1,2,3] means glycan1 + glycan2 + glycan3 are on the peptide.
         {
             get
             {
                 return string.Join(",", ModIds.Select(p => p.ToString()));
             }
         }
-
-        public byte[] Kind{ get; private set; }
-
     }
 }