Skip to content

Commit e772514

Browse files
cecoecocecoeco
committed
Initial commit
0 parents  commit e772514

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+9303
-0
lines changed

‎.github/workflows/CI.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: CI
2+
on:
3+
push:
4+
branches: [main, master]
5+
tags: ["*"]
6+
pull_request:
7+
jobs:
8+
test:
9+
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
10+
runs-on: ${{ matrix.os }}
11+
strategy:
12+
fail-fast: false
13+
matrix:
14+
version:
15+
- "1" # automatically expands to the latest stable 1.x release of Julia
16+
os:
17+
- ubuntu-latest
18+
arch:
19+
- x64
20+
- x86
21+
include:
22+
# test macOS and Windows with latest Julia only
23+
- os: macOS-latest
24+
arch: x64
25+
version: 1
26+
- os: windows-latest
27+
arch: x64
28+
version: 1
29+
- os: windows-latest
30+
arch: x86
31+
version: 1
32+
steps:
33+
- uses: actions/checkout@v2
34+
- uses: julia-actions/setup-julia@v1
35+
with:
36+
version: ${{ matrix.version }}
37+
arch: ${{ matrix.arch }}
38+
- uses: actions/cache@v1
39+
env:
40+
cache-name: cache-artifacts
41+
with:
42+
path: ~/.julia/artifacts
43+
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
44+
restore-keys: |
45+
${{ runner.os }}-test-${{ env.cache-name }}-
46+
${{ runner.os }}-test-
47+
${{ runner.os }}-
48+
- uses: julia-actions/julia-buildpkg@v1
49+
- uses: julia-actions/julia-runtest@v1
50+
- uses: julia-actions/julia-processcoverage@v1
51+
- uses: codecov/codecov-action@v2
52+
with:
53+
files: lcov.info
54+
docs:
55+
name: Documentation
56+
runs-on: ubuntu-latest
57+
steps:
58+
- uses: actions/checkout@v2
59+
- uses: julia-actions/julia-buildpkg@latest
60+
- uses: julia-actions/julia-docdeploy@latest
61+
env:
62+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
63+
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

‎.github/workflows/CompatHelper.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: CompatHelper
2+
on:
3+
schedule:
4+
- cron: '00 00 * * *'
5+
workflow_dispatch:
6+
jobs:
7+
CompatHelper:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Pkg.add("CompatHelper")
11+
run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
12+
- name: CompatHelper.main()
13+
env:
14+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
15+
COMPATHELPER_PRIV: ${{ secrets.COMPATHELPER_PRIV }}
16+
run: julia -e 'using CompatHelper; CompatHelper.main(;subdirs=["", "docs"])'

‎.github/workflows/TagBot.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: TagBot
2+
on:
3+
issue_comment:
4+
types:
5+
- created
6+
workflow_dispatch:
7+
jobs:
8+
TagBot:
9+
if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: JuliaRegistries/TagBot@v1
13+
with:
14+
token: ${{ secrets.GITHUB_TOKEN }}
15+
ssh: ${{ secrets.DOCUMENTER_KEY }}

‎.gitignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
logs
2+
*.log
3+
npm-debug.log*
4+
yarn-debug.log*
5+
yarn-error.log*
6+
pnpm-debug.log*
7+
lerna-debug.log*
8+
node_modules
9+
dist
10+
dist-ssr
11+
*.local
12+
.vscode/
13+
!.vscode/extensions.json
14+
.idea
15+
*.suo
16+
*.ntvs*
17+
*.njsproj
18+
*.sln
19+
*.sw?
20+
*.jl.cov
21+
*.jl.*.cov
22+
*.jl.mem
23+
deps/deps.jl
24+
deps/build.log
25+
deps/downloads/
26+
deps/usr/
27+
deps/src/
28+
docs/build/
29+
docs/site/
30+
Manifest.toml
31+
!app/backend/Manifest.toml
32+
.DS_Store
33+
out
34+
build
35+
draft

‎CITATION.bib

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
@software{PRISMA.jl,
2+
author = {Maples, Ceco Elijah},
3+
title = {PRISMA.jl: Generate checklists and flow diagrams based on the Preferred Reporting Items for Systematic Reviews and Meta-Analyses (PRISMA)},
4+
url = {https://github.com/cecoeco/PRISMA.jl}
5+
}

‎LICENSE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright 2024 Ceco Elijah Maples
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎Project.toml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name = "PRISMA"
2+
uuid = "7b67a8d2-c4f5-4933-b91c-0fc427024db5"
3+
authors = ["Ceco Elijah Maples <mapleselijah9@gmail.com>", "PRISMA.jl Contributors"]
4+
version = "0.0.6"
5+
6+
[deps]
7+
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
8+
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
9+
DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
10+
Graphviz_jll = "3c863552-8265-54e4-a6dc-903eb78fde85"
11+
HTMLTables = "b1afcece-b80e-4563-b90e-36b4cc56d3fa"
12+
JSON3 = "0f8b85d8-7281-11e9-16c2-39a750bddbf1"
13+
JSONTables = "b9914132-a727-11e9-1322-f18e41205b0b"
14+
LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
15+
Poppler_jll = "9c32591e-4766-534b-9725-b71a8799265b"
16+
Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
17+
TidierStrings = "248e6834-d0f8-40ef-8fbb-8e711d883e9c"
18+
Transformers = "21ca0261-441d-5938-ace7-c90938fde4d4"
19+
XLSX = "fdbf4ff8-1666-58a4-91e7-1b58723a45e0"
20+
21+
[compat]
22+
CSV = "0.10"
23+
DataFrames = "1.6"
24+
DataStructures = "0.18"
25+
Graphviz_jll = "2.50"
26+
HTMLTables = "0.4"
27+
HTTP = "1"
28+
JSON3 = "1"
29+
JSONTables = "1"
30+
LinearAlgebra = "1"
31+
Poppler_jll = "24.6"
32+
Statistics = "1"
33+
TidierStrings = "0.2"
34+
Transformers = "0.3"
35+
XLSX = "0.10"
36+
julia = "1"
37+
38+
[extras]
39+
HTTP = "cd3eb016-35fb-5094-929b-558a96fad6f3"
40+
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
41+
42+
[targets]
43+
test = ["HTTP", "Test"]

‎README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# PRISMA.jl
2+
3+
<br>
4+
<div align="center">
5+
<img src="logo.svg" width="18%">
6+
</div>
7+
<br>
8+
9+
Julia package and full-stack [web application](https://prisma-jl.onrender.com) powered by [`Solid.js`](https://www.solidjs.com/) and [`Oxygen.jl`](https://github.com/OxygenFramework/Oxygen.jl) for generating checklists and flow diagrams based on [the 2020 **P**referred **R**eporting **I**tems for **S**ystematic **R**eviews and **M**eta-**A**nalyses (PRISMA) statement (Page et al., 2021).](https://doi.org/10.1186/s13643-021-01626-4)
10+
11+
**Features:**
12+
13+
- natural language processing (NLP) of manuscript PDFs to generate 2020 PRISMA checklists.
14+
- highly customizable 2020 PRISMA flow diagrams generated from study data.
15+
- Interactive web app that requires zero programming knowledge.
16+
17+
**Installation:** use this command in the Julia REPL: `using Pkg; Pkg.add("PRISMA")`
18+
19+
**Documentation:** <a href="https://cecoeco.github.io/PRISMA.jl/stable/"><img src="https://img.shields.io/badge/docs-stable-4c9fff.svg" alt="Documentation Stable" /></a> <a href="https://cecoeco.github.io/PRISMA.jl/dev/"><img src="https://img.shields.io/badge/docs-dev-4c9fff.svg" alt="Documentation Dev"></a>
20+
21+
**Citing:** please consider citing PRISMA.jl and giving the GitHub repository a star, if possible.
22+
23+
The citation information may be found in the [`CITATION.bib`](CITATION.bib) file within the repository
24+
25+
**References:**
26+
27+
> Bezanson, J., Edelman, A., Karpinski, S., & Shah, V. B. (2017). Julia: A fresh approach to numerical computing. SIAM Review, 59(1), 65–98. https://doi.org/10.1137/141000671
28+
29+
> Bouchet-Valat, M., & Kamiński, B. (2023). DataFrames.jl: Flexible and Fast Tabular Data in Julia. Journal of Statistical Software, 107(4), 1–32. https://doi.org/10.18637/jss.v107.i04
30+
31+
> Page M J, McKenzie J E, Bossuyt P M, Boutron I, Hoffmann T C, Mulrow C D et al. (2021). The PRISMA 2020 statement: An updated guideline for reporting systematic reviews. Systematic Reviews, 10(1), 89. https://doi.org/10.1186/s13643-021-01626-4

‎app/backend/Dockerfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
FROM julia:1.10
2+
WORKDIR /backend
3+
COPY Project.toml Manifest.toml ./
4+
COPY src src
5+
RUN julia --project -e "using Pkg; Pkg.instantiate()"
6+
ENTRYPOINT [ "julia", "--project", "src/app.jl" ]

0 commit comments

Comments
 (0)