ImagingDataCommons / IDC-WebApp

Web Application front end for IDC (CORE REPO)
Apache License 2.0
6 stars 2 forks source link

Capitalization of collection names should be consistent with TCIA conventions in all places #414

Closed fedorov closed 2 years ago

fedorov commented 4 years ago

Currently, it is lower-case in the right panel.

image

fedorov commented 4 years ago

George says it's just formatting, will be fixed to use upper case, consistent with the TCIA conventions.

ulrikew commented 4 years ago

Beware, TCIA uses upper and lower case depending on the collection. image

fedorov commented 4 years ago

@ulrikew indeed, so you recommend we use those names? As @bcli4d identified and documented, there are differences in spelling between the various ways those names can be obtained, between TCIA_API_CollectionID, NBIA_CollectionID and TCIA_Webapp_CollectionID.

As a preview, see below, but I can also make a complete list. As you can see, it is not as trivial as using '_' in place of ' '.

Is it a bug or something that need to be addressed on the TCIA/NBIA side to make sure the names are consistent across the various ways those names can be obtained?

image

fedorov commented 3 years ago

@G-White-ISB @s-paquette can we switch to using tcia_api_collection_id from idc-dev-etl:idc_v2.auxilliary_metadata for the name of the collection displayed in the webapp?

image

As you can see from the summary here: https://docs.google.com/spreadsheets/d/1CZTY8SkPM4mJlSihx-NQ4lZqD5begW67JxpkUjHIyyI/edit?usp=sharing, it's not a simple transformation from idc_webapp_collection_id, and I think it is fair for the user to expect consistency in the names of the collections between IDC and TCIA.

G-White-ISB commented 3 years ago

TCIA collection names (https://www.cancerimagingarchive.net/collections/) should now appear consistently in IDC

fedorov commented 3 years ago

Great, thanks - I see it on dev.

Did you notice that now there are some rendering issues do to lack of wraparound for top-level names?

image

madelyngreyes commented 3 years ago

There is another field that has text cut off for count value.

Screen Shot 2021-05-13 at 3 37 26 PM
ulrikew commented 3 years ago

We have similar issues in NBIA and have brought this up as a topic in this morning's NBIA/TCIA call. Our plan is to work towards a size limit for the collection short names. Which max length would IDC prefer?

fedorov commented 3 years ago

I am not sure it is a good idea to change the collection names for the existing collections, so I think we need to have a way to deal with the current lengths. Did you think about enacting the limit going forward, or also for the existing collections, Ulli?

ulrikew commented 3 years ago

@fedorov I do not yet know the answer to your question. I will put it on the IRCoCo agenda for all to discuss.

G-White-ISB commented 2 years ago

Old issue but worth checking again? I think we are now consistent

s-paquette commented 2 years ago

@fedorov @ulrikew Do we now meet the requirements of this ticket?

ulrikew commented 2 years ago

Yes, looks good. Only (very minor) difference I found was the last letter in the MIDRC collection names. Don't fix.