Add Var._delete_model

Author: ph-kev

src/Leaderboard.jl

@@ -482,6 +482,36 @@ function add_model(rmse_var::RMSEVariable, models::String...)
     )
 end
 
+"""
+    _delete_model(rmse_var::RMSEVariable, models::String...)
+
+Delete one or more models named `models` from `rmse_var`.
+"""
+function _delete_model(rmse_var::RMSEVariable, models::String...)
+    # Delete model name
+    mdl_names = model_names(rmse_var)
+    num_rows = length(mdl_names)
+    setdiff!(mdl_names, models)
+
+    # Delete model
+    rmses = rmse_var.RMSEs |> copy
+    indices_to_delete = (rmse_var.model2index[model] for model in models)
+    rmses = rmse_var.RMSEs[setdiff(1:num_rows, indices_to_delete), :]
+
+    # Delete unit for model
+    units = rmse_var.units |> deepcopy
+    for name in models
+        delete!(units, name)
+    end
+    return RMSEVariable(
+        rmse_var.short_name,
+        mdl_names,
+        category_names(rmse_var),
+        rmses,
+        units,
+    )
+end
+
 """
     _model_name_check(rmse_var::RMSEVariable, model_name)
 

test/test_Leaderboard.jl

@@ -245,6 +245,37 @@ end
     @test all(isnan.(rmse_var[:, "new cat 2"]))
 end
 
+@testset "Removing model" begin
+    csv_file_path = joinpath(@__DIR__, "sample_data/test_csv.csv")
+    rmse_var = ClimaAnalysis.read_rmses(csv_file_path, "ta")
+    rmse_var = ClimaAnalysis.add_model(rmse_var, "new model", "new model 2")
+    rmse_var[2, 5] = 10.0
+    rmse_var_delete = ClimaAnalysis.Leaderboard._delete_model(
+        rmse_var,
+        "ACCESS-CM2",
+        "new model",
+    )
+    @test rmse_var_delete.short_name == "ta"
+    @test ClimaAnalysis.model_names(rmse_var_delete) ==
+          ["ACCESS-ESM1-5", "new model 2"]
+    @test ClimaAnalysis.category_names(rmse_var_delete) ==
+          ClimaAnalysis.category_names(rmse_var)
+    @test rmse_var_delete[1, :] == rmse_var[2, :]
+    @test all(isnan.(rmse_var_delete[2, :]))
+
+    # Delete all models
+    rmse_var_delete = ClimaAnalysis.Leaderboard._delete_model(
+        rmse_var_delete,
+        "ACCESS-ESM1-5",
+        "new model 2",
+    )
+    @test rmse_var_delete.short_name == "ta"
+    @test isempty(ClimaAnalysis.model_names(rmse_var_delete))
+    @test ClimaAnalysis.category_names(rmse_var_delete) ==
+          ClimaAnalysis.category_names(rmse_var)
+    @test rmse_var_delete[:, :] |> size == (0, 5)
+end
+
 @testset "Adding units" begin
     csv_file_path = joinpath(@__DIR__, "sample_data/test_csv.csv")
     rmse_var = ClimaAnalysis.read_rmses(csv_file_path, "ta")