Add TPM boxplots to the sides of differential gene expression heatmaps.
Resolved #61
Resolved #62
Notes for reviewers:
It is recommended to review this PR after #60 is merged to the main branch, because the file changes in this PR are based on the changes in #60.
In the review, please only add comments or suggestions that are directly related code correctness or documentation readability.
This PR is not broken into smaller PRs, because all changes in this PR are required to test whether the API works as expected or not. Most of the file changes are test results and plots.
Type of change
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update
Changed the interfaces of the following endpoints by adding two required parameters, includeBoxplot and boxplotYAxisScale, to determine whether to add boxplots with certain Y-axis scales on the sides of the differential gene expression (DGE) heatmaps or not.
/dge/top-gene-disease-gtex-diff-exp/plot
/dge/gene-all-cancer-gtex-diff-exp/plot
How Has This Been Tested?
[x] Integration test
Task link/Screenshot/Terminal returns:
$ ./tests/run_tests.sh
API base URL: http://localhost:8082
✔ | OK F W S | Context
✔ | 453 | tests/r_test_scripts/test_endpoint_http.R [782.3 s]
══ Results ════════════════
Duration: 782.4 s
[ FAIL 0 | WARN 0 | SKIP 0 | PASS 453 ]
Done running run_tests.sh
For more details about local testing environment, options, and resources, see README.md of this PR branch.
Checklist
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my own code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[NA] New and existing unit tests pass locally with my changes
[NA] Any dependent changes have been merged and published in downstream modules
[x] I have checked my code and corrected any misspellings
Pull Request Template
Description
Add TPM boxplots to the sides of differential gene expression heatmaps.
Notes for reviewers:
main
branch, because the file changes in this PR are based on the changes in #60.Type of change
Changed the interfaces of the following endpoints by adding two required parameters,
includeBoxplot
andboxplotYAxisScale
, to determine whether to add boxplots with certain Y-axis scales on the sides of the differential gene expression (DGE) heatmaps or not./dge/top-gene-disease-gtex-diff-exp/plot
/dge/gene-all-cancer-gtex-diff-exp/plot
How Has This Been Tested?
Task link/Screenshot/Terminal returns:
For more details about local testing environment, options, and resources, see
README.md
of this PR branch.Checklist
cc @taylordm @chinwallaa