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

Update News.md with RFC87 #10941

Merged
merged 2 commits into from
Sep 5, 2024
Merged

Update News.md with RFC87 #10941

merged 2 commits into from
Sep 5, 2024

Conversation

pappde
Copy link
Contributor

@pappde pappde commented Aug 14, 2024

Adding a news item summarizing RFC87, for review. Includes:

  • description of the button
  • external link for more details
  • note that not enabled in private instances
  • link to how to enable
  • preview image

Notify reviewers

@jjgao @alisman

docs/News.md Outdated
## August 14, 2024

* **New feature**: There is a new interactive 3D visualization software tool integrated with cBioPortal, for users running Windows. Once installed, a button will be available on all group comparison data tables, which will load it in the software with an interactive 3D Landscape with data shaping tools, including integrated pathways. Read more on [AVM for cBioPortal](https://bit.ly/avm-cbioportal).
* **Customization Note**: This button is not configured by default in private instances. Please see [Customization](deployment/customization/download_custom_buttons-Reference.md).
Copy link
Contributor Author

Choose a reason for hiding this comment

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

used relative cross-link (per other PR) so it works in the github repo browser as well

Copy link
Member

Choose a reason for hiding this comment

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

@pappde Thanks for the draft. I suggest we simplify the text as below.

  • New feature (Windows user only): The Group Comparison results can now be visualized in 3D with AVM, an interactive 3D visualization software tool. Read more on AVM for cBioPortal.
    • Note for private instances: To enable this feature in private cBioPortal instances, please follow this instruction.

Adding @tmazor @inodb @schultzn for comments. Note that the feature is already out and it's also visible here (https://www.cbioportal.org/visualize).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jjgao Updated with new phrasing. See the new diff. Also entering in this comment to reflect the latest commit:

  • New feature (Windows users only): The Group Comparison results can now be visualized in 3D with AVM, an interactive 3D visualization software tool with data shaping functions and integrated pathways. Read more on AVM for cBioPortal.
    • Note for private instances: To enable this feature in private cBioPortal instances, please see this instruction.

I did include the "with .... pathways" feature note since "interactive 3D visualization" alone may imply a simple static representation of the table data, which isn't as useful.

Also Note: the new feature allows data-driven definition of buttons. That's why the original text was titled "Customization" but I agree we really want to keep it simple here. So I changed the link to the application.properties reference document (which does actually link to the Customization document that was previously linked).

@alisman alisman merged commit f043915 into cBioPortal:master Sep 5, 2024
8 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants