cBioPortal / oncotree

Creative Commons Attribution 4.0 International
35 stars 26 forks source link

created validate_oncotree_uri.py : for checking against topbraid #181

Closed sheridancbio closed 5 years ago

sheridancbio commented 5 years ago
sheridancbio commented 5 years ago

@ao508 : I'm a little confused. You are suggesting that the uri mapping file should be moved out of the docs directory. But this file is not just mock data for unit testing ... it is actually the persistent definition of the mapping between concept ids and oncotree codes, and is (was I guess) used by the automated tool which would generate .rdf files for import into topbraid. (https://github.com/sheridancbio/oncotree-transformer). So this file is considered the "source of truth" to which topbraid must conform. It keeps the concept URIs consistent across different oncotree versions. There are also external users who have been looking at this file directly to understand the history relationships. The URIs are not guaranteed to be maintained (they are not part of the API interface), but some have found them helpful to understand the internal organization of oncotree.

If you would like to see the "docs" folder become primarily about resources for frontend presentation (.md5, images, etc) that would be fine with me. But I think this file .. and perhaps other non-presented documentation about the oncotree project should be kept in a place for us to reference and to share with people using oncotree. For instance, we have a bunch of google docs that are not visible to the outside world, but if we could render those in a distributable format (.pdf? .rtf?) we could put those along with other engineering documents in a folder for our (and other developer) reference.

ao508 commented 5 years ago

@sheridancbio what if the uri mapping file was instead moved to /src/main/resources?

I do believe that the data_clinical_sample_test*.txt files however should definitely be moved to a separate directory specifically for test resources.

sheridancbio commented 5 years ago

@ao508 ok, makes sense. We just had a conversation and decided:

sheridancbio commented 5 years ago
sheridancbio commented 5 years ago

Corrections have been made to render a couple of section headers correctly. Also trailing whitespace has been cleaned up.

sheridancbio commented 5 years ago

having anchor links within the tool documentation page is problematic. Other parts of the website use the "hash" part of the URL to open various tabs or show various oncotree versions, so the parsing of these hash tags and the configuration of the display is under javascript control now. using hashes for intra-page navigation is not automatic and we would need to program the javascript parser to do the proper navigation within this page. For now I have dropped all intra-page navigation.

The "A" element links are now shown in blue if unvisited, and black once already visited. hover-over is dark grey. I've dropped the Additional resources section and put links in the appropriate places.