Get the docs/, templates/analyses, and the templates_examples/csvs/ up-to-date #2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Updates the documentation, analysis templates, and template_examples/csvs files with the latest code changes
Why
Noticed an issue when trying to run the pre-commit githook. The ATACseq analysis definition still referred to a "report" field that had been removed previously. See (75535d3). The docs/ were out of date.
How
The pre-commit util was installing an out-of-date version of the schemas. I opted to skip that step and instead run the pre-commit steps manually. First, I made sure
PYTHONPATH
included the cidc-schemas root directory and that I didn't have any installed version of cidc-schemas in site-packages. Then I ran thepython docs/generate_docs.py
script followed by the./.githooks/pre-commit
script. I ran into an issue with git referencing files with different names. I opted to skip thegit add
andgit rm
steps in the pre-commit script. Instead I tracked down the problem files (ATACSEQ_Analysis.csv, plasma_template__shipment.csv, and pbmc_template__shipment.csv) and usedgit mv
to the correct names.Remarks
Checklist
Please include and complete the following checklist. You can mark an item as complete with the
- [x]
prefix:black
andflake8
have been used to ensure styling guidelines are metdocs/
has be regenerated and README and CHANGELOG have been updated to explain major changes & new featurescidc_schemas/__init__.py