-
Notifications
You must be signed in to change notification settings - Fork 18
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
Expose ImzMLParser.polarity, fix ReadTheDocs #27
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
docs/source/conf.py
Outdated
@@ -90,7 +91,7 @@ | |||
|
|||
# List of patterns, relative to source directory, that match files and | |||
# directories to ignore when looking for source files. | |||
exclude_patterns = ['_build'] | |||
exclude_patterns = ['_build', 'tests', 'setup'] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems necessary to rename _build
to build
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch. I just tested building locally and found that actually this exclude_patterns
value isn't needed because I disabled the automatic .rst
-file generation by removing rtd_gen_docs
, and the other .rst
files specify exact modules paths.
I changed it to exclude the whole docs
directory, just in case the automatic module-finding is turned on again in the future.
Several changes to make my life easier when working with ImzML files:
ImzMLParser.polarity
field calculated from the headerReferenceableParamGroups
and first spectrum metadataaccession="MS:1000128" name="positive scan"
params.ImzMLParser
consistently. Without polarity information, some other ImzML tools (e.g. MSIReader) won't load the processed files.MS:1000128
("profile spectrum") instead ofMS:1000130
("positive scan"). I checked all the ImzML headers from METASPACE (as of ~8 months ago) and found that when this incorrect accession is used, it's always in thereferenceableParamGroups
in the header, so this doesn't need any fix in the per-spectrum metadata reading code.Also, as this library has quite a few external users now, I've been working to try to improve its overall quality:
CHANGELOG.md