DOCSEARCHbyAlgolia
Submit Docs

PRISMA2020

repository·main·Indexed 42 days ago

https://github.com/prisma-flowdiagram/prisma2020

An R package and Shiny app for producing PRISMA 2020-compliant flow diagrams. It features the `PRISMA_flowdiagram()` function for generating static or interactive HTML outputs with hover-over tooltips and clickable links, supporting both manual data entry and CSV imports.

Tokens
396
Snippets
2
Records
2
Agent score
5%

What's inside PRISMA2020

  1. Generate PRISMA 2020 flow diagrams with PRISMA_flowdiagram()

    main

    Use the PRISMA_flowdiagram() function to produce flow diagrams that conform to PRISMA 2020 standards.

    Data Input Options:

    • Manual Entry: Pass data directly into the function arguments.
    • CSV Import: Load data using the template CSV file located in the INST/EXTDATA/ directory of the package.

    Output Formats:

    • Interactive HTML: Set interactive = TRUE to generate an interactive HTML output. This version includes hover-over tooltips for additional information and clickable boxes that link to specific pages (such as search results or method details).
    • Static Diagram: By default, the function produces a static version of the diagram.

    Customization:

    • You can toggle the 'Previous' and 'Other' study arms on or off, adding or removing them from the diagram via the function inputs.
    # Example conceptual usage
PRISMA_flowdiagram(..., interactive = TRUE)

  2. Install and run the PRISMA2020 Shiny app via Docker

    main

    You can quickly set up the PRISMA2020 package and run the included example Shiny app using Docker. This provides a point-and-click user interface for generating diagrams.

    1. Build the Docker image:

      docker build . -t prisma-shiny:1

    2. Run the container:

      docker run -it --rm -p 3838:3838 prisma-shiny:1

    3. Access the app: Open your web browser and navigate to http://localhost:3838/app.

    To stop the application, press Ctrl+C in your terminal.

    docker build . -t prisma-shiny:1
docker run -it --rm -p 3838:3838 prisma-shiny:1