diff --git a/CHANGELOG.md b/CHANGELOG.md index b1a7a4f..467ca28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,24 +1,15 @@ -# task_predict_modality x.y.z +# task_predict_modality 0.1.0 -## BREAKING CHANGES - - +Initial release after migrating the codebase. ## NEW FUNCTIONALITY -* Added `control_methods/true_labels` component (PR #5). +* Control methods: Solution, Mean per gene, Random Predictions, Zeros. -* Added `methods/logistic_regression` component (PR #5). +* Methods: Guanlab-dengkw, KNNR, Linear Model -* Added `metrics/accuracy` component (PR #5). +* Metrics: MAE, Mean pearson / spearman, RMSE ## MAJOR CHANGES -* Updated `api` files (PR #5). - -## MINOR CHANGES - -* Updated `README.md` (PR #5). - -## BUGFIXES - +* Refactored the API schema. diff --git a/README.md b/README.md index 34ab1be..00f01fc 100644 --- a/README.md +++ b/README.md @@ -35,33 +35,32 @@ data shows that this is not trivial. | Alejandro Granados | author | | Alex Tong | author | | Bastian Rieck | author | +| Christopher Lance | author | | Daniel Burkhardt | author | | Kai Waldrant | contributor | | Kaiwen Deng | contributor | | Louise Deconinck | author | | Robrecht Cannoodt | author, maintainer | -| Xueer Chen | contributor | -| Jiwei Liu | contributor | ## API ``` mermaid -flowchart LR - file_common_dataset_mod1("Raw dataset RNA") - comp_process_datasets[/"Process Dataset"/] - file_test_mod1("Test mod1") - file_test_mod2("Test mod2") - file_train_mod1("Train mod1") - file_train_mod2("Train mod2") - comp_control_method[/"Control method"/] - comp_method_predict[/"Predict"/] - comp_method_train[/"Train"/] - comp_method[/"Method"/] - comp_metric[/"Metric"/] - file_prediction("Prediction") - file_pretrained_model("Pretrained model") - file_score("Score") - file_common_dataset_mod2("Raw dataset mod2") +flowchart TB + file_common_dataset_mod1("Raw dataset RNA") + comp_process_datasets[/"Process Dataset"/] + file_test_mod1("Test mod1") + file_test_mod2("Test mod2") + file_train_mod1("Train mod1") + file_train_mod2("Train mod2") + comp_control_method[/"Control method"/] + comp_method_predict[/"Predict"/] + comp_method_train[/"Train"/] + comp_method[/"Method"/] + comp_metric[/"Metric"/] + file_prediction("Prediction") + file_pretrained_model("Pretrained model") + file_score("Score") + file_common_dataset_mod2("Raw dataset mod2") file_common_dataset_mod1---comp_process_datasets comp_process_datasets-->file_test_mod1 comp_process_datasets-->file_test_mod2 @@ -69,16 +68,16 @@ flowchart LR comp_process_datasets-->file_train_mod2 file_test_mod1---comp_control_method file_test_mod1---comp_method_predict - file_test_mod1---comp_method_train + file_test_mod1-.-comp_method_train file_test_mod1---comp_method file_test_mod2---comp_control_method file_test_mod2---comp_metric file_train_mod1---comp_control_method - file_train_mod1---comp_method_predict + file_train_mod1-.-comp_method_predict file_train_mod1---comp_method_train file_train_mod1---comp_method file_train_mod2---comp_control_method - file_train_mod2---comp_method_predict + file_train_mod2-.-comp_method_predict file_train_mod2---comp_method_train file_train_mod2---comp_method comp_control_method-->file_prediction diff --git a/_viash.yaml b/_viash.yaml index d32a429..6952bf5 100644 --- a/_viash.yaml +++ b/_viash.yaml @@ -45,6 +45,11 @@ authors: roles: [ author ] info: github: Pseudomanifold + - name: Christopher Lance + roles: [ author ] + info: + github: xlancelottx + orcid: "0000-0002-1275-9802" - name: Daniel Burkhardt roles: [ author ] info: diff --git a/scripts/create_readme.sh b/scripts/create_readme.sh index 432aab4..d1ada96 100755 --- a/scripts/create_readme.sh +++ b/scripts/create_readme.sh @@ -2,4 +2,4 @@ set -e -common/scripts/create_task_readme +common/scripts/create_task_readme --input src