search

mcguinlu / robvis

A package to quickly visualise risk-of-bias assessment results
https://mcguinlu.github.io/robvis/
Other
58 stars 22 forks source link

Better description in opening paragraph of README #117

Closed mcguinlu closed 1 year ago

mcguinlu commented 3 years ago

It would be useful to have a better description of where the robvis/risk-of-bias assessments generally fall within the evidence synthesis/systematic review framework at the top of the README.

This was made clear by the positive reaction to the intro paragraph of medrxivr README

ekothe commented 3 years ago

Is this intention to have a short paragraph (or set of paragraphs) explaining why a person would want to create these visualisations for risk of bias? Something like... "The Cochrane Handbook says that risk of bias information should be presented graphically and provides a number of examples of how such information might be presented... This package provides a simple method for generating these figures..." (but in fancy words)

ekothe commented 3 years ago

Is this intention to have a short paragraph (or set of paragraphs) explaining why a person would want to create these visualisations for risk of bias? Something like... "The Cochrane Handbook says that risk of bias information should be presented graphically and provides a number of examples of how such information might be presented... This package provides a simple method for generating these figures..." (but in fancy words)

Have you considering using some of the intro to your robvis paper? It's creative commons so it looks like you could use the verbatim text if you were so inclined.

mcguinlu commented 3 years ago

Yep, that's it exactly - there is a lot in the README on the "how" but not really the "what" or "why".

I hadn't thought of using the text from the paper - that's a great idea!