Adding body maps with selectable grids of size 10 pixels x 10 pixels

ctsit / imagemap

Imagemap REDCap external module

Other

14 stars 27 forks source link

Adding body maps with selectable grids of size 10 pixels x 10 pixels #76

Closed schatto1 closed 5 months ago

schatto1 commented 6 months ago

Hi!

A study here at University of Utah wanted to use the Image Map module, but with granular selectable areas on a body map (front and back). This is currently in use with a production project and we have a version 1.11.1 running on our server- wanted to see if we can merge this upstream so we don't have to maintain our custom Image Map module in the filesystem.

Would be happy to make any changes if required!

Our team previously inquired about this in the forum: https://redcap.vumc.org/community/post.php?id=206492. This would be step 7!

davwillev commented 6 months ago

This would be a very useful addition to the module for other users

pbchase commented 6 months ago

@schatto1, could you update the README.md to describe your new imagemap? Could you do it in the style in which the other imagemaps are already documented? I.e., add these things:

A section that describes the image map, shows the images, and shows the keys and values for the image map. Give your image map a name. At the moment it looks you're calling it "GRIDS" or "Grids Body Map", or maybe "Grids for CTSI7245". Pick a name and run with that. The section should also say why your image map is special. This module already has multiple body maps, but yours must be special for some reason. Tell us why it is special. I'm sure you know that reason better than us, so we'd like you to write that.
An entry Usage section that tells us what action tag will invoke your imagemap
An entry in the Acknowledgements & Copyright section that acknowledges the creator of the image map and any copyright holder(s). It seems likely there is some investigator that wants their work acknowledged.

schatto1 commented 6 months ago

Thanks @pbchase - will work on that right away!

saipavan10-git commented 6 months ago

Hi @schatto1 ,

I’ve attached a zip file with an example instrument crafted with the grid body image maps. This example serves as a guide to demonstrate the application of the new imagemaps. You are welcome to modify and adapt it as needed. You can add this example instrument to the documentation folder within this repository at docs.

grids_body_maps_Instrument Example.zip

schatto1 commented 6 months ago

Hi @pbchase and @saipavan10-git,

Thanks so much for your patience. I just pushed the following:

README containing an updated name and description of the image map, an entry in the Usage section, and an entry in the Acknowledgements & Copyright section
config.json that has the updated name and description of the image map
Instrument example zip file that has all the image maps, including the fields for the grid body image maps created by @saipavan10-git
example_project XML file that has all the image maps, including the fields for the grid body image maps created by @saipavan10-git

Please let me know if there's anything else that needs be modified, thanks!

saipavan10-git commented 5 months ago

LGTM. Tested the imagemaps using the example instrument. It works as expected.

schatto1 commented 5 months ago

Thank you!