TRON-Bioinformatics / neofox

Annotation of mutated peptide sequences with published or novel potential neoantigen descriptors
GNU General Public License v3.0
27 stars 6 forks source link

docs: remove mention of _neoantigen_features.json from docs, as it is not created #4

Closed dlaehnemann closed 2 years ago

dlaehnemann commented 2 years ago

A quick grep -r "_neoantigen_features.json" neofox/ in the main directory of the repo on the develop branch doesn't give any results. So it seems this file is never created, even when --with-json is set. Thus, this PR removes its mention from the docs.

priesgo commented 2 years ago

You are completely right and this is very confusing. Let me explain.

The file *_neoantigen_features.json is intended to hold the metadata on the annotated features. This is totally redundant as it will be always the same for every run, but on the other hand, its size will be negligible. That said, I think we lost track of the need of implementing this. I will make sure we do it for the next release on which we are working.

I am closing this issue on behalf of https://github.com/TRON-Bioinformatics/neofox/issues/8