Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: remove gene_index step #946

Merged
merged 19 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
5e1a475
refactor: rename all gene_index related files to target_index
vivienho Dec 5, 2024
26abb1b
refactor: rename gene_index to target_index in various files
vivienho Dec 5, 2024
19bb7c9
refactor: rename gene_index to target_index in tests
vivienho Dec 6, 2024
98bc6bc
Merge branch 'dev' into vh-gene-index-to-target-index
vivienho Jan 13, 2025
d26ddfd
refactor: rename fields to be compatible with new target_index
vivienho Jan 14, 2025
307b7cc
refactor: replace examples that use gene_index
vivienho Jan 14, 2025
306de99
refactor: delete gene_index step files
vivienho Jan 14, 2025
a8c6d07
refactor: remove gene_index step from config
vivienho Jan 15, 2025
1d3f975
feat: replace the gene_index schema with the target_index schema
vivienho Jan 16, 2025
fc8df50
refactor: modify mock_target_index
vivienho Jan 16, 2025
8331efc
fix: remove mock_target_index from test_validate_schema_missing_field
vivienho Jan 16, 2025
92e6da6
refactor: delete target.md
vivienho Jan 16, 2025
b5f4492
fix: fix study index validation tests
vivienho Jan 17, 2025
59dd931
fix: fix l2g feature tests
vivienho Jan 20, 2025
5444ea5
Merge branch 'dev' into vh-gene-index-to-target-index
vivienho Jan 20, 2025
91796f2
chore: pre-commit auto fixes [...]
pre-commit-ci[bot] Jan 20, 2025
20fc538
revert: revert column name after merging from dev
vivienho Jan 20, 2025
3582b34
Merge branch 'vh-gene-index-to-target-index' of https://github.com/op…
vivienho Jan 20, 2025
024975c
Merge branch 'dev' into vh-gene-index-to-target-index
DSuveges Jan 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions docs/howto/command_line/run_step_in_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Available options:
eqtl_catalogue
finngen_studies
finngen_sumstat_preprocess
gene_index
gwas_catalog_ingestion
gwas_catalog_sumstat_preprocess
ld_index
Expand All @@ -28,16 +27,16 @@ Available options:
Set the environment variable HYDRA_FULL_ERROR=1 for a complete stack trace.
```

As indicated, you can run a step by specifying the step's name with the `step` argument. For example, to run the `gene_index` step, you can run:
As indicated, you can run a step by specifying the step's name with the `step` argument. For example, to run the `gwas_catalog_sumstat_preprocess` step, you can run:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the documentation! I keep forgetting about it.


```bash
gentropy step=gene_index
gentropy step=gwas_catalog_sumstat_preprocess
```

In most occassions, some mandatory values will be required to run the step. For example, the `gene_index` step requires the `step.target_path` and `step.gene_index_path` argument to be specified. You can complete the necessary arguments by adding them to the command line:
In most occassions, some mandatory values will be required to run the step. For example, the `gwas_catalog_sumstat_preprocess` step requires the `step.raw_sumstats_path` and `step.out_sumstats_path` argument to be specified. You can complete the necessary arguments by adding them to the command line:

```bash
gentropy step=gene_index step.target_path=/path/to/target step.gene_index_path=/path/to/gene_index
gentropy step=gwas_catalog_sumstat_preprocess step.raw_sumstats_path=/path/to/raw_sumstats step.out_sumstats_path=/path/to/out_sumstats
```

You can find more about the available steps in the [documentation](../../python_api/steps/_steps.md).
18 changes: 9 additions & 9 deletions docs/howto/command_line/run_step_using_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ To run a step using a configuration file, you need to create a configuration fil
```{ .sh .no-copy }
config/
├─ step/
│ └─ my_gene_index.md
│ └─ my_gwas_catalog_sumstat_preprocess.md
└─ my_config.yml
```

The configuration file should contain the parameters you want to use to run the step. For example, to run the `gene_index` step, you need to specify the `step.target_path` and `step.gene_index_path` parameters. The configuration file should look like this:
The configuration file should contain the parameters you want to use to run the step. For example, to run the `gwas_catalog_sumstat_preprocess` step, you need to specify the `step.raw_sumstats_path` and `step.out_sumstats_path` parameters. The configuration file should look like this:

=== "my_config.yaml"

Expand All @@ -31,20 +31,20 @@ The configuration file should contain the parameters you want to use to run the

This config file will specify that your configuration file will inherit the default configuration (`config`) and everything provided (`_self_`) will overwrite the default configuration.

=== "step/my_gene_index.md"
=== "step/my_gwas_catalog_sumstat_preprocess.md"

``` yaml
defaults:
- gene_index
- gwas_catalog_sumstat_preprocess

target_path: /path/to/target
gene_index_path: /path/to/gene_index
raw_sumstats_path: /path/to/raw_sumstats
out_sumstats_path: /path/to/out_sumstats
```

This config file will inherit the default configuration for the `gene_index` step and overwrite the `target_path` and `gene_index_path` parameters.
This config file will inherit the default configuration for the `gwas_catalog_sumstat_preprocess` step and overwrite the `raw_sumstats_path` and `out_sumstats_path` parameters.

Once you have created the configuration file, you can run your own new `my_gene_index`:
Once you have created the configuration file, you can run your own new `my_gwas_catalog_sumstat_preprocess`:

```bash
gentropy step=my_gene_index --config-dir=config --config-name=my_config
gentropy step=my_gwas_catalog_sumstat_preprocess --config-dir=config --config-name=my_config
```
9 changes: 0 additions & 9 deletions docs/python_api/datasets/gene_index.md

This file was deleted.

9 changes: 9 additions & 0 deletions docs/python_api/datasets/target_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Target Index
---

::: gentropy.dataset.target_index.TargetIndex

## Schema

--8<-- "assets/schemas/target_index.md"
5 changes: 0 additions & 5 deletions docs/python_api/datasources/open_targets/target.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/python_api/steps/gene_index.md

This file was deleted.

69 changes: 0 additions & 69 deletions src/gentropy/assets/schemas/gene_index.json

This file was deleted.

Loading
Loading