aphp / eds-scikit

eds-scikit is a Python library providing tools to process and analyse OMOP data
https://aphp.github.io/eds-scikit
BSD 3-Clause "New" or "Revised" License
35 stars 5 forks source link

docs: :lipstick: Update bioclean table for clarity #23

Closed Aremaki closed 1 year ago

Aremaki commented 1 year ago

Update bioclean table for clarity

codecov-commenter commented 1 year ago

Codecov Report

Base: 95.08% // Head: 95.09% // Increases project coverage by +0.00% :tada:

Coverage data is based on head (8c529d8) compared to base (2ad6ec3). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #23 +/- ## ======================================= Coverage 95.08% 95.09% ======================================= Files 65 65 Lines 2034 2038 +4 ======================================= + Hits 1934 1938 +4 Misses 100 100 ``` | [Impacted Files](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp) | Coverage Δ | | |---|---|---| | [eds\_scikit/biology/utils/process\_concepts.py](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp#diff-ZWRzX3NjaWtpdC9iaW9sb2d5L3V0aWxzL3Byb2Nlc3NfY29uY2VwdHMucHk=) | `96.71% <ø> (ø)` | | | [eds\_scikit/icu/icu\_care\_site.py](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp#diff-ZWRzX3NjaWtpdC9pY3UvaWN1X2NhcmVfc2l0ZS5weQ==) | `100.00% <0.00%> (ø)` | | | [eds\_scikit/structures/description.py](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp#diff-ZWRzX3NjaWtpdC9zdHJ1Y3R1cmVzL2Rlc2NyaXB0aW9uLnB5) | `100.00% <0.00%> (ø)` | | | [eds\_scikit/emergency/emergency\_visit.py](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp#diff-ZWRzX3NjaWtpdC9lbWVyZ2VuY3kvZW1lcmdlbmN5X3Zpc2l0LnB5) | `100.00% <0.00%> (ø)` | | | [eds\_scikit/emergency/emergency\_care\_site.py](https://codecov.io/gh/aphp/eds-scikit/pull/23?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp#diff-ZWRzX3NjaWtpdC9lbWVyZ2VuY3kvZW1lcmdlbmN5X2NhcmVfc2l0ZS5weQ==) | `90.32% <0.00%> (+0.32%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=aphp)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

Vincent-Maladiere commented 1 year ago

Besides, after reading the tutorial, I think it would add clarity to highlight the default way to load the config when you're a user from APHP:

biology_config = registry.data.get("get_biology_config.all_aphp")()

Most users will try to have something running quickly and then make some edits to the config file.

Then, we should also have a code snippet where bioclean have the default APHP value to make things easier:

from eds_scikit.biology import bioclean

bioclean(
    data,
    config_name="all_aphp",
    concepts_sets=concepts_sets,
    start_date=start_date,
    end_date=end_date,
)

What do you think @Aremaki?

Thomzoy commented 1 year ago

Besides, after reading the tutorial, I think it would add clarity to highlight the default way to load the config when you're a user from APHP:

biology_config = registry.data.get("get_biology_config.all_aphp")()

Most users will try to have something running quickly and then make some edits to the config file.

Then, we should also have a code snippet where bioclean have the default APHP value to make things easier:

from eds_scikit.biology import bioclean

bioclean(
    data,
    config_name="all_aphp",
    concepts_sets=concepts_sets,
    start_date=start_date,
    end_date=end_date,
)

What do you think @Aremaki?

Good idea ! I implemented it in the notebook.