Skip to content
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

Customizable Transcripts on Gene Pages #1169

Merged
merged 10 commits into from Mar 2, 2021
Merged

Conversation

spficklin
Copy link
Member

New Feature

Issue #100

Description

This PR adds new functionality that has been requested for quite some time: supporting dynamic and customizable gene pages. In particular the issue of how to display nested data about transcripts is addressed. The solution is to allow the site admin to customize the so__transcripts field. The site admin can edit the field on the gene page and select fields from an mRNA content type that should be shown. They can also reorder the fields as needed. This will allow the site admin to show as much or as little information as desired about a transcript and allow different Tripal sites to customize this.

Despite that the display is changed for transcripts, the web services data is not changed. But rather in web services the list of transcripts is provided and the end-user can obtain all the information about a transcript by following the link for the transcript.

This PR also includes an update to the User's Guide instructing site admins how to customize the transcripts.

Testing?

Below are screenshots of the updated User documentation. Just follow those instructions.

image
image
image
image
image

@spficklin spficklin added Community - Enhancement Suggestions for improvements or enhancements to Tripal. Tripal 3 Any issue or pull requuest focused on Tripal 3 labels Feb 22, 2021
@Ferrisx4
Copy link
Member

Initial manual testing is positive so far. Question - is it/would it be possible to hide fields within the Transcripts fieldset that do not have values such as for Product:
Transcript Product No Value

@mpoelchau Also is wondering if it is possible to make it recognize other custom transcript types such as lnc_RNA.

@spficklin
Copy link
Member Author

HI @Ferrisx4 . Yes, if you go to Admin > Structure > Tripal Content Types then click on the 'edit' link for mRNA there is a checkbox to hide fields with missing values. Check that, save the mRNA content type then reload the gene page. Those empty fields should be gone.

@Ferrisx4
Copy link
Member

ok thanks @spficklin. I had been testing this on a Gene page so I had checked that box for Gene pages. Now I see it makes sense that this setting has to be enabled for mRNA since the Transcript is of that type.

Copy link
Member

@chunhuaicheng chunhuaicheng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested and worked as described. A nice new function for the transcripts field.

@spficklin
Copy link
Member Author

Thanks @chunhuaicheng for the review!

Copy link
Member

@Ferrisx4 Ferrisx4 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other than the five empty PNG files, this all looks good and also functions as advertised.

@spficklin
Copy link
Member Author

Thanks @Ferrisx4 for the review as well. Those empty files are showing up now. I'm not sure why there were empty before but now are there. I'm going to merge. Thanks.

@spficklin spficklin merged commit c3b2392 into 7.x-3.x Mar 2, 2021
@spficklin spficklin deleted the 100-tv3-gene_pages branch March 2, 2021 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community - Enhancement Suggestions for improvements or enhancements to Tripal. Tripal 3 Any issue or pull requuest focused on Tripal 3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants