Skip to content

Commit bfda836

Browse files
committed
update readme
1 parent a741028 commit bfda836

File tree

3 files changed

+21
-16
lines changed

3 files changed

+21
-16
lines changed

README.md

+19-14
Original file line numberDiff line numberDiff line change
@@ -44,21 +44,21 @@ should consist of similar cell types from similar tissues.
4444
## API
4545

4646
``` mermaid
47-
flowchart LR
48-
comp_process_datasets[/"Process Dataset"/]
49-
file_dataset_sc("Single-Cell Dataset")
50-
file_dataset_sp("Spatial Dataset")
51-
comp_metric[/"Metric"/]
52-
comp_control_method[/"Control Method"/]
53-
comp_method[/"Method"/]
54-
file_score("Score")
55-
file_simulated_dataset("Solution")
47+
flowchart TB
48+
comp_process_datasets[/"<a href='https://github.com/openproblems-bio/task_spatial_simulators#component-type-process-dataset'>Process Dataset</a>"/]
49+
file_dataset_sc("<a href='https://github.com/openproblems-bio/task_spatial_simulators#file-format-single-cell-dataset'>Single-Cell Dataset</a>")
50+
file_dataset_sp("<a href='https://github.com/openproblems-bio/task_spatial_simulators#file-format-spatial-dataset'>Spatial Dataset</a>")
51+
comp_metric[/"<a href='https://github.com/openproblems-bio/task_spatial_simulators#component-type-metric'>Metric</a>"/]
52+
comp_control_method[/"<a href='https://github.com/openproblems-bio/task_spatial_simulators#component-type-control-method'>Control Method</a>"/]
53+
comp_method[/"<a href='https://github.com/openproblems-bio/task_spatial_simulators#component-type-method'>Method</a>"/]
54+
file_score("<a href='https://github.com/openproblems-bio/task_spatial_simulators#file-format-score'>Score</a>")
55+
file_simulated_dataset("<a href='https://github.com/openproblems-bio/task_spatial_simulators#file-format-solution'>Solution</a>")
5656
comp_process_datasets-->file_dataset_sc
5757
comp_process_datasets-->file_dataset_sp
5858
file_dataset_sc---comp_metric
5959
file_dataset_sp---comp_metric
60-
file_dataset_sp---comp_control_method
61-
file_dataset_sp---comp_method
60+
file_dataset_sp-.-comp_control_method
61+
file_dataset_sp-.-comp_method
6262
comp_metric-->file_score
6363
comp_control_method-->file_simulated_dataset
6464
comp_method-->file_simulated_dataset
@@ -82,10 +82,15 @@ Arguments:
8282
| `--output_sp` | `file` | (*Output*) An unprocessed spatial dataset as output by a dataset loader. Default: `$id/output_sp.h5ad`. |
8383
| `--dataset_id` | `string` | NA. |
8484
| `--dataset_name` | `string` | NA. |
85-
| `--dataset_url` | `string` | (*Optional*) NA. |
85+
| `--dataset_url_spatial` | `string` | (*Optional*) NA. |
86+
| `--dataset_url_singlecell` | `string` | (*Optional*) NA. |
8687
| `--dataset_reference` | `string` | (*Optional*) NA. |
87-
| `--dataset_summary` | `string` | NA. |
88-
| `--dataset_description` | `string` | NA. |
88+
| `--dataset_reference_spatial` | `string` | (*Optional*) NA. |
89+
| `--dataset_reference_singlecell` | `string` | (*Optional*) NA. |
90+
| `--dataset_summary_spatial` | `string` | NA. |
91+
| `--dataset_summary_singlecell` | `string` | NA. |
92+
| `--dataset_description_spatial` | `string` | NA. |
93+
| `--dataset_description_singlecell` | `string` | NA. |
8994
| `--dataset_organism` | `string` | NA. |
9095
| `--dataset_assay_spatial` | `string` | NA. |
9196
| `--dataset_assay_singlecell` | `string` | NA. |

scripts/create_readme.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
set -e
44

5-
common/scripts/create_task_readme
5+
common/scripts/create_task_readme --input src

0 commit comments

Comments
 (0)