Merge pull request #4 from konradoberwimmer/improvements/provide-repr…

…oducible-R-session-code provide reproducible R session code
konradoberwimmer · Jul 17, 2024 · 48032bd · 48032bd
2 parents 7fc973b + e14d5ab
commit 48032bd
Show file tree

Hide file tree

Showing 9 changed files with 97 additions and 20 deletions.
diff --git a/LSAnalyzer/README.md b/LSAnalyzer/README.md
@@ -1,7 +1,6 @@
 # ToDo-List
 Test and debug!
 
-* update and fix session log to provide reproducible R code of the whole session
 * split application core and UI in separate assemblies to possibly switch to AvaloniaUI
 * refactoring of data table creation and management OR switch from BIFIEsurvey to a specialized R package for LSAnalyzer
 

diff --git a/LSAnalyzer/Services/Logging.cs b/LSAnalyzer/Services/Logging.cs
@@ -9,15 +9,21 @@ namespace LSAnalyzer.Services
     public class Logging
     {
         private List<LogEntry> _logEntries = new();
+        public List<LogEntry> LogEntries { get => _logEntries; }
 
         public void AddEntry(LogEntry logEntry)
         {
             _logEntries.Add(logEntry);
         }
 
-        public string Stringify()
+        public string GetRcode()
         {
-            return String.Join("\n", _logEntries.ConvertAll<string>(logEntry => logEntry.Stringify()).ToArray());
+            return String.Join("\n", _logEntries.ConvertAll<string>(logEntry => logEntry.Rcode).ToArray());
+        }
+
+        public string GetFullText()
+        {
+            return String.Join("\n", _logEntries.ConvertAll<string>(logEntry => logEntry.ToFullText()).ToArray());
         }
     }
 
@@ -26,15 +32,19 @@ public class LogEntry
         public DateTime When { get; set; }
         public string? AnalysisName { get; set; }
         public string Rcode { get; set; }
+        public bool OneLiner { get; set; }
+
+        public string RcodeForTableCell => (OneLiner && Rcode.Contains('\n')) ? Rcode.Substring(0, Rcode.IndexOf('\n')) + "\n..." : Rcode;
 
-        public LogEntry(DateTime when, string rcode, string? analysisName = null)
+        public LogEntry(DateTime when, string rcode, string? analysisName = null, bool oneLiner = false)
         {
             When = when;
             Rcode = rcode;
             AnalysisName = analysisName;
+            OneLiner = oneLiner;
         }
 
-        public string Stringify()
+        public string ToFullText()
         {
             return When.ToString() + " - " + AnalysisName + " - " + Rcode;
         }

diff --git a/LSAnalyzer/Services/Rservice.cs b/LSAnalyzer/Services/Rservice.cs
@@ -38,7 +38,7 @@ public Rservice(Logging logger)
 
         private SymbolicExpression EvaluateAndLog(string what, string? analysisName = null, bool oneLiner = false)
         {
-            _logger.AddEntry(new LogEntry(DateTime.Now, (oneLiner && what.Contains("\n")) ? what.Substring(0, what.IndexOf("\n")) : what, analysisName));
+            _logger.AddEntry(new LogEntry(DateTime.Now, what, analysisName, oneLiner));
             return _engine!.Evaluate(what);
         }
 
@@ -1354,11 +1354,11 @@ public bool PrepareForAnalysis(Analysis analysis, List<string>? additionalVariab
             }
         }
 
-        public virtual bool Execute(string rCode)
+        public virtual bool Execute(string rCode, bool oneLiner = false)
         {
             try
             {
-                EvaluateAndLog(rCode, null, true);
+                EvaluateAndLog(rCode, null, oneLiner);
                 return true;
             } catch
             {

diff --git a/LSAnalyzer/ViewModels/SystemSettings.cs b/LSAnalyzer/ViewModels/SystemSettings.cs
@@ -68,9 +68,9 @@ public string? BifieSurveyVersion
             }
         }
 
-        public string? SessionLog
+        public Logging SessionLog
         {
-            get => _logger.Stringify();
+            get => _logger;
         }
 
         [ExcludeFromCodeCoverage]
@@ -175,7 +175,28 @@ private void SaveSessionLog(string? filename)
             }
 
             using StreamWriter streamWriter = new(filename, false);
-            streamWriter.Write(_logger.Stringify());
+            streamWriter.Write(_logger.GetFullText());
+        }
+
+        private RelayCommand<string?> _saveSessionRcodeCommand = null!;
+        public ICommand SaveSessionRcodeCommand
+        {
+            get
+            {
+                _saveSessionRcodeCommand ??= new RelayCommand<string?>(this.SaveSessionRcode);
+                return _saveSessionRcodeCommand;
+            }
+        }
+
+        private void SaveSessionRcode(string? filename)
+        {
+            if (filename == null)
+            {
+                return;
+            }
+
+            using StreamWriter streamWriter = new(filename, false);
+            streamWriter.Write(_logger.GetRcode());
         }
     }
 

diff --git a/LSAnalyzer/Views/SystemSettings.xaml b/LSAnalyzer/Views/SystemSettings.xaml
@@ -64,10 +64,17 @@
                     <RowDefinition/>
                     <RowDefinition Height="Auto"/>
                 </Grid.RowDefinitions>
-                <ScrollViewer Grid.Row="0" HorizontalScrollBarVisibility="Auto" VerticalScrollBarVisibility="Auto">
-                    <TextBlock Text="{Binding SessionLog}" TextWrapping="NoWrap"/>
-                </ScrollViewer>
-                <Button x:Name="buttomSaveSessionLog" Grid.Row="1" Margin="0,5,0,0" HorizontalAlignment="Right" Content="Save ..." Height="22" Width="80" Click="ButtonSaveSessionLog_Click"/>
+                <DataGrid Grid.Row="0" ItemsSource="{Binding SessionLog.LogEntries}" AutoGenerateColumns="False" IsReadOnly="True">
+                    <DataGrid.Columns>
+                        <DataGridTextColumn Header="Time" Binding="{Binding When}"/>
+                        <DataGridTextColumn Header="Analysis" Binding="{Binding AnalysisName}"/>
+                        <DataGridTextColumn Header="R code" Binding="{Binding RcodeForTableCell}"/>
+                    </DataGrid.Columns>
+                </DataGrid>
+                <StackPanel Grid.Row="1" Margin="0,5,0,0" Orientation="Horizontal" HorizontalAlignment="Right">
+                    <Button x:Name="buttomSaveSessionRcode" Content="Save R code (.R) ..." Height="22" Width="100" Margin="0,0,10,0" Click="ButtonSaveSessionRcode_Click"/>
+                    <Button x:Name="buttomSaveSessionLog" Content="Save All (.txt) ..." Height="22" Width="100" Click="ButtonSaveSessionLog_Click"/>
+                </StackPanel>
             </Grid>
         </GroupBox>
     </Grid>

diff --git a/LSAnalyzer/Views/SystemSettings.xaml.cs b/LSAnalyzer/Views/SystemSettings.xaml.cs
@@ -45,6 +45,26 @@ private void HyperLinkGPL3_RequestNavigate(object sender, System.Windows.Navigat
             System.Diagnostics.Process.Start(sInfo);
         }
 
+        private void ButtonSaveSessionRcode_Click(object sender, RoutedEventArgs e)
+        {
+            if (sender is not Button button || DataContext is not ViewModels.SystemSettings systemSettingsViewModel)
+            {
+                return;
+            }
+
+            SaveFileDialog saveFileDialog = new SaveFileDialog();
+            saveFileDialog.Filter = "R Script File (*.R)|*.R";
+            saveFileDialog.InitialDirectory = Properties.Settings.Default.lastResultOutFileLocation ?? Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
+            var wantsSave = saveFileDialog.ShowDialog(this);
+
+            if (wantsSave == true)
+            {
+                Properties.Settings.Default.lastResultOutFileLocation = Path.GetDirectoryName(saveFileDialog.FileName);
+                Properties.Settings.Default.Save();
+                systemSettingsViewModel.SaveSessionRcodeCommand.Execute(saveFileDialog.FileName);
+            }
+        }
+
         private void ButtonSaveSessionLog_Click(object sender, RoutedEventArgs e)
         {
             if (sender is not Button button || DataContext is not ViewModels.SystemSettings systemSettingsViewModel)

diff --git a/TestLSAnalyzer/ViewModels/DataProvider/TestDataverse.cs b/TestLSAnalyzer/ViewModels/DataProvider/TestDataverse.cs
@@ -28,7 +28,7 @@ public async Task TestTestFileAccess()
             .Returns(false)
             .Returns(true)
             .Returns(true);
-        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>()))
+        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>(), It.IsAny<bool>()))
             .Returns(false)
             .Returns(true).Returns(true).Returns(true);
 
@@ -75,7 +75,7 @@ public void TestLoadDataTemporarilyAndGetVariables()
         configuration.ApiToken = "token";
 
         var rserviceMock = new Mock<Rservice>();
-        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>()))
+        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>(), It.IsAny<bool>()))
             .Returns(true).Returns(false)
             .Returns(true).Returns(true).Returns(true).Returns(true)
             .Returns(true).Returns(true).Returns(true).Returns(true);
@@ -109,7 +109,7 @@ public void TestLoadDataForUsage()
         configuration.ApiToken = "token";
 
         var rserviceMock = new Mock<Rservice>();
-        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>()))
+        rserviceMock.SetupSequence(rservice => rservice.Execute(It.IsAny<string>(), It.IsAny<bool>()))
             .Returns(true).Returns(false)
             .Returns(true).Returns(true).Returns(true).Returns(true).Returns(true);
 

diff --git a/TestLSAnalyzer/ViewModels/TestDataProviders.cs b/TestLSAnalyzer/ViewModels/TestDataProviders.cs
@@ -184,7 +184,7 @@ public void TestTestDataProvider()
 
         var RServiceMock = new Mock<Rservice>();
         RServiceMock.Setup(rservice => rservice.CheckNecessaryRPackages(It.IsAny<string>())).Returns(true);
-        RServiceMock.Setup(rservice => rservice.Execute(It.IsAny<string>())).Returns(true);
+        RServiceMock.Setup(rservice => rservice.Execute(It.IsAny<string>(), It.IsAny<bool>())).Returns(true);
 
         ServiceCollection services = new();
         services.AddSingleton(RServiceMock.Object);

diff --git a/TestLSAnalyzer/ViewModels/TestSystemSettings.cs b/TestLSAnalyzer/ViewModels/TestSystemSettings.cs
@@ -12,6 +12,26 @@ namespace TestLSAnalyzer.ViewModels
     [Collection("Sequential")]
     public class TestSystemSettings
     {
+        [Fact]
+        public void TestSaveSessionRcodeCommand()
+        {
+            Logging logger = new();
+            Configuration configuration = new("");
+            Rservice rservice = new(logger);
+
+            Assert.True(rservice.Connect(), "R must also be available for tests");
+            Assert.True(rservice.InjectAppFunctions());
+
+            SystemSettings systemSettingsViewModel = new(rservice, configuration, logger);
+
+            var filename = Path.GetTempFileName();
+            systemSettingsViewModel.SaveSessionRcodeCommand.Execute(filename);
+
+            var savedLog = File.ReadAllText(filename);
+            Assert.Contains("lsanalyzer_func_quantile <- function(", savedLog);
+            Assert.DoesNotContain("- lsanalyzer_func_quantile <- function(", savedLog);
+        }
+
         [Fact]
         public void TestSaveSessionLogCommand()
         {
@@ -28,7 +48,7 @@ public void TestSaveSessionLogCommand()
             systemSettingsViewModel.SaveSessionLogCommand.Execute(filename);
 
             var savedLog = File.ReadAllText(filename);
-            Assert.Contains("lsanalyzer_func_quantile <- function(", savedLog);
+            Assert.Contains("- lsanalyzer_func_quantile <- function(", savedLog);
         }
 
         [Fact]