Revision of the Data Report documentation #18
Conversation
updated the report specific landing page with some further details
updated the page with some further explanations
minor changes added
further edits to add module links
further edits to add module links
further edits to add module links
…to docs_update_report
ionicsolutions
changed the title
|
@sourjyasen07 @ionicsolutions seems all the checks have failed for the above. Can we also add a sample report together with this merge? |
|
@kajanansangar Thanks for the suggestion, we'll take this up! It's fine for now that the test build fails: We're missing the correct links to the API docs and the test build is set to be super strict and fails if there's even one link that points to a missing file. With the API docs now merged, we can rebase this branch once we're happy with the content and fix the links to the API docs prior to merging. |
|
@sourjyasen07 Could you please have a look if the "Generating data reports via the configuration file" section is complete and correct from your point of view? Will you take care of filling in the "Generating data reports through individual modules" section and providing the example @kajanansangar sugested as well? I feel you're the most qualified to get this done quickly. @sourjyasen07 @kajanansangar Do you have a suggestion where to document the |
ionicsolutions
requested review from
kajanansangar
and removed request for
kajanansangar
|
@sourjyasen07 Do you have any update on this PR? |
dattranm
left a comment
dattranm
left a comment
There was a problem hiding this comment.
The png images have pretty low quality and resolution, thus potentially the users may find it hard to see and interpret these images. Is there any way to increase the quality and resolution of these?
|
Can you please point out which images are you referring to? @dattranm |
dattranm
left a comment
dattranm
left a comment
There was a problem hiding this comment.
The list of images that need to be updated:
- executive-report-1.png
- executive-report-3.png
- wiki-2.png
- wiki-3.png
- descriptive-statistics-2.png
- descriptive-statistics-3.png
- descriptive-statistics-4.png
- descriptive-statistics-5.png
- attribute-association-1.png
You can find them in anovos-docs/docs/assets/html-reports. Ideally, if possible, we should update all the old images that were added 13 months ago, but the list above is the most crucial for now.
| _Anovos_ generates reports in two steps: | ||
|
|
||
| 1. The data that will be included in the report is generated using the functions of the | ||
| [`data_analyzer`](../../docs/api/data-analyzer/_index.md)[`association_evaluator`](../../docs/api/data_analyzer/association-evaluator.md)[`data_drift_stability`](../../docs/api/drift_stability/index.md)[`quality_checker`](../../docs/api/data_analyzer/quality_checker.md) module. |
There was a problem hiding this comment.
I think in here, you can omit the docs too, so the link will become ../../api/data-analyzer/_index.md. This applies for all links with format ../../docs/* in here.
| ### Basic Report | ||
|
|
||
| In case you do not need an exhaustive report that contains all the detailed outputs of the | ||
| [`data_analyzer`](../../docs/api/data-analyzer/_index.md), |
| ### Full Report | ||
|
|
||
| The detailed and exhaustive full report contains a structured and well-formatted outputs of the | ||
| [`data_analyzer`](../../docs/api/data-analyzer/_index.md), |
|
@dattranm I have updated the above mentioned images along with a few others which had poor resolution. Also corrected the other typos. Please let me know if something else needs to be done. |
|
Hey @bidyutparna . Can you also address these comments as well? #18 (comment). When you remove the |
updated the report specific landing page with some further details