Evidence map›Paper›PMID 28088754›Full record

ArticleBriefings in bioinformatics2018

Top considerations for creating bioinformatics software documentation.

Mehran Karimzadeh, Michael M Hoffman

Abstract read
In one paragraph

Article in Briefings in bioinformatics, 2018. The graph could read no effect estimate from its abstract, so it casts no vote on the map. Cited by 30 papers, 2 of them syntheses that pooled it.

0numbers the graph read from it
0cells of the map it votes in
30citing papers in PubMed, 2 pooled it
–field-weighted citation impact
1 · What the graph read from it

What it found

Each row is one number read from the abstract, on the scale the paper reported it, with its interval. Left of the dashed line favours the treatment, right favours the comparator. Under each row is the sentence it came from. New to these charts? A ten-minute tutorial.

The abstract states no effect estimate the extractor could read, or names no intervention and outcome on the map, so this paper lights no cell and moves no belief. It is still indexed, cited and linked below.

2 · The registry

The trial behind it

Trials whose registry record cites this paper, or whose number appears in the abstract. A trial that started after this paper was published is citing it as background, not reporting it.

Neither the registry nor the abstract names a trial number. If this is a trial report, that itself is worth knowing.

3 · Its place in the literature

Who cites it

30 citing papers in PubMed, 2 syntheses or guidelines pooled it.

  1. Pooled it
  2. Pooled it
  3. Article
  4. Open-Source and FAIR Research Software for Proteomics.Journal of proteome research · 2025
    Review
  5. Harnessing artificial intelligence for engineering extracellular vesicles.Extracellular vesicles and circulating nucleic acids · 2025
    Review
  6. Article
  7. Article
  8. Article
  9. Article
  10. Article
  11. Article
  12. Article
  13. Article
  14. Article
  15. Article
  16. Nine quick tips for pathway enrichment analysis.PLoS computational biology · 2022
    Article
  17. Article
  18. Review
  19. Article
  20. Article
4 · The record

Corrections and comments

PubMed lists nothing against this paper. Absence here is not a guarantee, only a check that was made.

5 · Who and what money

Authors and funding

2 authors.

Mehran KarimzadehDepartment of Medical Biophysics, University of Toronto, Toronto, Canada.
Michael M HoffmanDepartment of Medical Biophysics, University of Toronto, Toronto, Canada.

Funding

No grant is acknowledged in the PubMed record.

6 · The paper itself

Abstract

Investing in documenting your bioinformatics software well can increase its impact and save your time. To maximize the effectiveness of your documentation, we suggest following a few guidelines we propose here. We recommend providing multiple avenues for users to use your research software, including a navigable HTML interface with a quick start, useful help messages with detailed explanation and thorough examples for each feature of your software. By following these guidelines, you can assure that your hard work maximally benefits yourself and others.

Indexed as

Guidelines as TopicComputational BiologyDocumentationHumansSoftware

Identifiers

PMID28088754
PMCPMC6054259

What OpenQuestion holds

Textmetadata
LicenceCC BY
Read underepoch 390

Registered trials

None linked

Read under generation 80e0d062 · epoch 390. Bibliography from PubMed, PubMed Central and OpenAlex; grants from NIH RePORTER; trial links from ClinicalTrials.gov; estimates, votes and beliefs from the OpenQuestion graph.