Spaces:
Sleeping
Sleeping
File size: 108,996 Bytes
54a4133 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 | import html
import inspect
import json
import os
import re
import tempfile
from dataclasses import dataclass
from datetime import datetime, timezone
from pathlib import Path
from typing import Any
from urllib.parse import quote
import gradio as gr
import matplotlib
import requests
from bs4 import BeautifulSoup
from docx import Document
from huggingface_hub import InferenceClient
from pypdf import PdfReader
matplotlib.use("Agg")
import matplotlib.pyplot as plt # noqa: E402
APP_NAME = "OpenStudy"
QWEN_MODEL_ID = "Qwen/Qwen3.6-27B"
MAX_ANALYSIS_CHARS = 180_000
MAX_QWEN_CONTEXT_CHARS = 18_000
REQUEST_TIMEOUT = 12
MIN_TOPIC_PAPERS = 15
DEFAULT_TOPIC_PAPERS = 15
MAX_TOPIC_PAPERS = 100
HEADERS = {
"User-Agent": "OpenStudy/0.1 (open-source research-bias-screening; https://huggingface.co/spaces)"
}
# --- OpenStudy design tokens ---------------------------------------------
BRAND = "#0e6b5f"
BRAND_DEEP = "#0a554b"
BRAND_BRIGHT = "#2fa08f"
PAPER = "#eef4f2"
CARD = "#ffffff"
INK = "#172522"
INK_SOFT = "#4f6660"
BORDER = "#d9e4e0"
WARN = "#b45309"
RISK = "#b91c1c"
THEME = gr.themes.Soft(
primary_hue="teal",
secondary_hue="emerald",
neutral_hue="stone",
font=[gr.themes.GoogleFont("Plus Jakarta Sans"), "ui-sans-serif", "system-ui", "sans-serif"],
font_mono=[gr.themes.GoogleFont("IBM Plex Mono"), "ui-monospace", "SFMono-Regular", "monospace"],
).set(
body_background_fill=PAPER,
body_background_fill_dark="#101614",
body_text_color=INK,
body_text_color_dark="#e9e7df",
body_text_color_subdued=INK_SOFT,
body_text_color_subdued_dark="#9fafa9",
background_fill_primary=CARD,
background_fill_primary_dark="#19221f",
background_fill_secondary=PAPER,
background_fill_secondary_dark="#141c19",
border_color_primary=BORDER,
border_color_primary_dark="#2b3733",
block_background_fill=CARD,
block_background_fill_dark="#19221f",
block_border_color=BORDER,
block_border_color_dark="#2b3733",
block_shadow="0 1px 2px rgba(32, 49, 45, 0.05)",
block_title_text_color=INK,
block_title_text_color_dark="#e9e7df",
block_label_text_color=INK_SOFT,
block_label_text_color_dark="#9fafa9",
block_label_background_fill=PAPER,
block_label_background_fill_dark="#141c19",
input_background_fill="#ffffff",
input_background_fill_dark="#101614",
input_border_color="#c4d5cf",
input_border_color_dark="#33403b",
button_primary_background_fill=BRAND,
button_primary_background_fill_hover=BRAND_DEEP,
button_primary_background_fill_dark=BRAND,
button_primary_background_fill_hover_dark="#128172",
button_primary_text_color="#ffffff",
button_primary_text_color_dark="#ffffff",
button_secondary_background_fill="#e2ece9",
button_secondary_background_fill_hover="#d6e4e0",
button_secondary_background_fill_dark="#243029",
button_secondary_background_fill_hover_dark="#2c3a32",
button_secondary_text_color=INK,
button_secondary_text_color_dark="#e9e7df",
table_even_background_fill="#f5f9f8",
table_even_background_fill_dark="#1b2421",
table_odd_background_fill=CARD,
table_odd_background_fill_dark="#19221f",
link_text_color=BRAND,
link_text_color_dark="#3db2a0",
color_accent_soft="#e3efec",
color_accent_soft_dark="#16302b",
slider_color=BRAND,
slider_color_dark=BRAND_BRIGHT,
)
STUDY_TYPE_CHOICES = [
"Auto-detect",
"Clinical trial",
"Observational study",
"Systematic review or meta-analysis",
"Qualitative study",
"Survey study",
"Animal or preclinical study",
"Model or algorithm study",
]
@dataclass(frozen=True)
class Criterion:
category: str
label: str
positive: tuple[str, ...]
recommendation: str
concern: tuple[str, ...] = ()
applies_to: tuple[str, ...] = ()
excludes: tuple[str, ...] = ()
@dataclass(frozen=True)
class Benchmark:
name: str
description: str
criteria: tuple[str, ...]
applies_to: tuple[str, ...] = ()
excludes: tuple[str, ...] = ()
CRITERIA: tuple[Criterion, ...] = (
Criterion(
"Design and protocol",
"Study design is named",
(
r"\brandomi[sz]ed\b",
r"\bclinical trial\b",
r"\bcohort\b",
r"\bcase[- ]control\b",
r"\bcross[- ]sectional\b",
r"\bsurvey\b",
r"\bqualitative\b",
r"\bsystematic review\b",
r"\bmeta[- ]analysis\b",
r"\bprospective\b",
r"\bretrospective\b",
),
"State the study design clearly enough for readers to judge what claims are supported.",
),
Criterion(
"Design and protocol",
"Protocol or preregistration is reported",
(
r"\bpre[- ]registered\b",
r"\bpreregistration\b",
r"\bregistered\b",
r"\bclinicaltrials\.gov\b",
r"\bprotocol\b",
r"\bosf\.io\b",
r"\bprospero\b",
),
"Report a protocol, registry entry, or explain why preregistration was not possible.",
),
Criterion(
"Design and protocol",
"Primary outcomes or endpoints are specified",
(
r"\bprimary outcome\b",
r"\bprimary endpoint\b",
r"\bsecondary outcome\b",
r"\bend ?point\b",
r"\boutcome measures?\b",
),
"Identify primary and secondary outcomes before presenting results.",
),
Criterion(
"Sampling and participants",
"Eligibility criteria are described",
(
r"\binclusion criteria\b",
r"\bexclusion criteria\b",
r"\beligib(le|ility)\b",
r"\bwere included\b",
r"\bwere excluded\b",
),
"Describe who could enter the study and who was excluded.",
),
Criterion(
"Sampling and participants",
"Recruitment source or study period is described",
(
r"\brecruited\b",
r"\benrolled\b",
r"\bconsecutive\b",
r"\bstudy period\b",
r"\bbetween [a-z]+ \d{4}\b",
r"\bfrom \d{4} to \d{4}\b",
r"\bdata were collected\b",
),
"Report where, when, and how participants or records were selected.",
),
Criterion(
"Sampling and participants",
"Sample size or power rationale is reported",
(
r"\bsample size\b",
r"\bpower (analysis|calculation)\b",
r"\bstatistical power\b",
r"\bminimum detectable\b",
),
"Provide a sample-size rationale, power analysis, or precision target.",
),
Criterion(
"Sampling and participants",
"Participant characteristics are reported",
(
r"\bbaseline characteristics\b",
r"\bdemographic",
r"\bage\b",
r"\bsex\b",
r"\bgender\b",
r"\brace\b",
r"\bethnicity\b",
),
"Report participant characteristics relevant to fairness and generalizability.",
),
Criterion(
"Bias controls",
"Random allocation is reported",
(
r"\brandomi[sz]ed\b",
r"\brandom allocation\b",
r"\ballocation sequence\b",
r"\bblock random",
r"\bstratified random",
),
"Describe the allocation method and who generated the sequence.",
applies_to=("clinical_trial", "animal"),
),
Criterion(
"Bias controls",
"Blinding or masking is reported",
(
r"\bdouble[- ]blind\b",
r"\bsingle[- ]blind\b",
r"\btriple[- ]blind\b",
r"\bblind(ed|ing)\b",
r"\bmask(ed|ing)\b",
),
"State whether participants, investigators, outcome assessors, or analysts were blinded.",
concern=(r"\bopen[- ]label\b", r"\bunblinded\b", r"\bnot blinded\b"),
applies_to=("clinical_trial", "animal"),
),
Criterion(
"Bias controls",
"Comparator or control condition is described",
(
r"\bcontrol group\b",
r"\bcontrol condition\b",
r"\bcomparator\b",
r"\bplacebo\b",
r"\busual care\b",
r"\bmatched controls?\b",
),
"Describe the comparator, control, or counterfactual condition.",
excludes=("review", "qualitative"),
),
Criterion(
"Bias controls",
"Confounding is addressed",
(
r"\bconfound",
r"\badjusted for\b",
r"\bmultivariable\b",
r"\bmultivariate\b",
r"\bpropensity score\b",
r"\binverse probability\b",
r"\bstratified analysis\b",
),
"Explain likely confounders and how the analysis reduces confounding.",
applies_to=("observational", "survey", "unknown"),
),
Criterion(
"Bias controls",
"Missing data, attrition, or follow-up is addressed",
(
r"\bmissing data\b",
r"\blost to follow[- ]up\b",
r"\battrition\b",
r"\bwithdrawn\b",
r"\bimputation\b",
r"\bcomplete case\b",
),
"Report missing data, exclusions after enrollment, attrition, and handling methods.",
),
Criterion(
"Bias controls",
"Measurement validity or reliability is addressed",
(
r"\bvalidated\b",
r"\bvalidation\b",
r"\breliability\b",
r"\binter[- ]rater\b",
r"\bintra[- ]class\b",
r"\bcalibrat",
r"\bstandardi[sz]ed\b",
),
"Describe validated instruments, calibration, or reliability checks for key measures.",
),
Criterion(
"Analysis",
"Statistical methods are named",
(
r"\bregression\b",
r"\banova\b",
r"\bt[- ]test\b",
r"\bchi[- ]square\b",
r"\bhazard ratio\b",
r"\bodds ratio\b",
r"\brisk ratio\b",
r"\bbayesian\b",
r"\bmodel\b",
),
"Name the statistical methods and connect them to the hypotheses or outcomes.",
),
Criterion(
"Analysis",
"Uncertainty is reported",
(
r"\bconfidence interval\b",
r"\bcredible interval\b",
r"\bstandard error\b",
r"\bstandard deviation\b",
r"\beffect size\b",
r"\bp ?[<=>]\s?0\.",
r"\bp-value\b",
),
"Report effect sizes and uncertainty, not only direction or significance.",
),
Criterion(
"Analysis",
"Sensitivity, subgroup, or robustness checks are reported",
(
r"\bsensitivity analysis\b",
r"\brobustness\b",
r"\bsubgroup analysis\b",
r"\bmultiple comparisons\b",
r"\bfalse discovery\b",
r"\bbonferroni\b",
),
"Show whether conclusions hold under reasonable alternative analyses.",
),
Criterion(
"Transparency",
"Data or code availability is reported",
(
r"\bdata availability\b",
r"\bavailable upon request\b",
r"\bopen data\b",
r"\bcode (is )?available\b",
r"\bgithub\.com\b",
r"\brepository\b",
r"\bsupplementary data\b",
),
"Provide data, code, materials, or a justified access limitation.",
),
Criterion(
"Ethics",
"Ethics approval or oversight is reported",
(
r"\binstitutional review board\b",
r"\birb\b",
r"\bethics committee\b",
r"\bethical approval\b",
r"\bethics approval\b",
r"\bapproved by\b",
r"\bdeclaration of helsinki\b",
),
"Report the oversight body, approval number when available, or exemption rationale.",
excludes=("review",),
),
Criterion(
"Ethics",
"Consent process is reported",
(
r"\binformed consent\b",
r"\bconsent (was )?obtained\b",
r"\bwritten consent\b",
r"\bwaiver of consent\b",
r"\bassent\b",
),
"State how consent was obtained or why consent was waived.",
excludes=("review", "animal"),
),
Criterion(
"Ethics",
"Privacy, confidentiality, or safety safeguards are reported",
(
r"\bconfidential",
r"\banonymi[sz]ed\b",
r"\bde[- ]identified\b",
r"\bprivacy\b",
r"\badverse events?\b",
r"\bsafety monitoring\b",
r"\bdata protection\b",
),
"Describe participant privacy protections and safety monitoring where relevant.",
excludes=("review", "animal"),
),
Criterion(
"Ethics",
"Animal welfare oversight is reported",
(
r"\biacuc\b",
r"\banimal care\b",
r"\banimal ethics\b",
r"\banimal welfare\b",
r"\barrive\b",
),
"Report animal-care approval and welfare safeguards.",
applies_to=("animal",),
),
Criterion(
"Funding and conflicts",
"Funding source is reported",
(
r"\bfunding\b",
r"\bfunded by\b",
r"\bgrant\b",
r"\bsponsor(ed|ship)?\b",
r"\bfinancial support\b",
),
"Report funding sources or state that no external funding was received.",
),
Criterion(
"Funding and conflicts",
"Conflicts or competing interests are reported",
(
r"\bconflicts? of interest\b",
r"\bcompeting interests?\b",
r"\bfinancial interests?\b",
r"\bno competing interests\b",
r"\bno conflicts?\b",
),
"Disclose conflicts of interest or explicitly state there were none.",
),
Criterion(
"Funding and conflicts",
"Funder or sponsor role is clarified",
(
r"\bfunder(s)? had no role\b",
r"\bsponsor(s)? had no role\b",
r"\bindependent of the funder\b",
r"\brole of the funding source\b",
),
"Clarify whether funders influenced design, analysis, interpretation, or publication.",
),
Criterion(
"Interpretation",
"Limitations are discussed",
(
r"\blimitations?\b",
r"\bstrengths and limitations\b",
r"\bexternal validity\b",
r"\bgeneralizability\b",
r"\bmay not generalize\b",
),
"Discuss limitations, generalizability, and remaining uncertainty.",
),
Criterion(
"Interpretation",
"Causal claims are appropriately constrained",
(
r"\bassociated with\b",
r"\bassociation between\b",
r"\bcorrelat",
r"\bcannot infer caus",
r"\bnot establish caus",
r"\bobservational\b",
),
"Avoid causal language unless the design supports causal inference.",
concern=(r"\bcauses?\b", r"\bcaused\b", r"\bleads to\b", r"\bprevents?\b"),
applies_to=("observational", "survey", "unknown"),
),
Criterion(
"Review methods",
"Search strategy and databases are reported",
(
r"\bsearch strategy\b",
r"\bpubmed\b",
r"\bmedline\b",
r"\bembase\b",
r"\bweb of science\b",
r"\bscopus\b",
r"\bcochrane\b",
),
"Report databases, search dates, and enough query detail to reproduce the review.",
applies_to=("review",),
),
Criterion(
"Review methods",
"Risk-of-bias or quality appraisal is reported",
(
r"\brisk of bias\b",
r"\bquality assessment\b",
r"\bcochrane risk\b",
r"\brobins\b",
r"\bnewcastle[- ]ottawa\b",
r"\bgrade\b",
),
"Assess included-study quality or risk of bias with an appropriate tool.",
applies_to=("review",),
),
Criterion(
"Review methods",
"Publication bias is considered",
(
r"\bpublication bias\b",
r"\bfunnel plot\b",
r"\begger",
r"\btrim and fill\b",
),
"Assess publication bias or explain why it could not be assessed.",
applies_to=("review",),
),
Criterion(
"Qualitative methods",
"Coding, reflexivity, or triangulation is reported",
(
r"\bthematic analysis\b",
r"\bcoding\b",
r"\bcodebook\b",
r"\breflexivity\b",
r"\btriangulation\b",
r"\bmember checking\b",
),
"Report coding procedures and researcher reflexivity checks.",
applies_to=("qualitative",),
),
Criterion(
"Model or algorithm studies",
"Validation split or external validation is reported",
(
r"\btraining set\b",
r"\btest set\b",
r"\bvalidation set\b",
r"\bcross[- ]validation\b",
r"\bexternal validation\b",
r"\bholdout\b",
),
"Describe training, validation, testing, and external validation if available.",
applies_to=("ml",),
),
Criterion(
"Model or algorithm studies",
"Fairness or subgroup performance is reported",
(
r"\bfairness\b",
r"\bbias audit\b",
r"\bsubgroup performance\b",
r"\bdemographic parity\b",
r"\bequalized odds\b",
),
"Report subgroup performance and fairness checks for affected populations.",
applies_to=("ml",),
),
)
BENCHMARKS: tuple[Benchmark, ...] = (
Benchmark(
"Protocol readiness",
"Design, protocol, outcomes, and sample-size planning are clear before strong claims are made.",
(
"Study design is named",
"Protocol or preregistration is reported",
"Primary outcomes or endpoints are specified",
"Sample size or power rationale is reported",
),
),
Benchmark(
"Participant selection fairness",
"Recruitment, eligibility, and participant characteristics are transparent enough to judge selection bias and generalizability.",
(
"Eligibility criteria are described",
"Recruitment source or study period is described",
"Participant characteristics are reported",
),
),
Benchmark(
"Bias control readiness",
"The project includes design or analysis safeguards that reduce expected sources of bias.",
(
"Random allocation is reported",
"Blinding or masking is reported",
"Comparator or control condition is described",
"Confounding is addressed",
"Measurement validity or reliability is addressed",
),
),
Benchmark(
"Ethical conduct readiness",
"Oversight, consent, privacy, safety, or welfare safeguards are described before data collection or publication.",
(
"Ethics approval or oversight is reported",
"Consent process is reported",
"Privacy, confidentiality, or safety safeguards are reported",
"Animal welfare oversight is reported",
),
),
Benchmark(
"Analysis integrity",
"The analysis plan reports methods, uncertainty, robustness checks, and missing-data handling.",
(
"Statistical methods are named",
"Uncertainty is reported",
"Sensitivity, subgroup, or robustness checks are reported",
"Missing data, attrition, or follow-up is addressed",
),
),
Benchmark(
"Transparency and conflicts",
"Data, code, funding, sponsor role, competing interests, and limitations are visible to reviewers.",
(
"Data or code availability is reported",
"Funding source is reported",
"Conflicts or competing interests are reported",
"Funder or sponsor role is clarified",
"Limitations are discussed",
),
),
Benchmark(
"Review-method completeness",
"Search strategy, included-study appraisal, and publication-bias assessment are planned or reported.",
(
"Search strategy and databases are reported",
"Risk-of-bias or quality appraisal is reported",
"Publication bias is considered",
),
applies_to=("review",),
),
Benchmark(
"Qualitative rigor",
"Qualitative coding, reflexivity, triangulation, or member-checking safeguards are planned or reported.",
("Coding, reflexivity, or triangulation is reported",),
applies_to=("qualitative",),
),
Benchmark(
"Algorithmic fairness",
"Model validation and subgroup or fairness checks are planned or reported for algorithmic studies.",
(
"Validation split or external validation is reported",
"Fairness or subgroup performance is reported",
),
applies_to=("ml",),
),
)
STANDARD_CATEGORIES = list(dict.fromkeys(criterion.category for criterion in CRITERIA))
STANDARD_CRITERIA_LABELS = [criterion.label for criterion in CRITERIA]
DEFAULT_RISK_THRESHOLDS = (50.0, 75.0)
CATEGORY_EXPLANATIONS = {
"Design and protocol": "Is the study design named, was it planned ahead (protocol or preregistration), and were primary outcomes specified before results?",
"Sampling and participants": "Who was studied, how they were recruited, eligibility rules, sample size justification, and participant characteristics.",
"Bias controls": "Protections against skewed results: randomization, blinding, comparator groups, validated measures, and confounder control.",
"Analysis": "Whether the statistical or qualitative analysis approach is described, including how missing data and attrition were handled.",
"Transparency": "Whether data, code, and materials are shared or their availability is explained.",
"Ethics": "Ethics approval or oversight, informed consent, privacy and safety safeguards, and animal welfare where relevant.",
"Funding and conflicts": "Who paid for the study, what role the funder played, and whether competing interests are disclosed.",
"Interpretation": "Whether limitations are discussed and conclusions stay within what the evidence supports.",
"Review methods": "For reviews: search strategy, quality appraisal of included studies, and publication-bias assessment.",
"Qualitative methods": "For qualitative work: coding approach, reflexivity, triangulation, or member checking.",
"Model or algorithm studies": "For models: validation on held-out or external data and fairness or subgroup performance checks.",
}
STATUS_ICONS = {
"Reported": "β
Reported",
"Potential concern": "β οΈ Potential concern",
"Missing or unclear": "β Missing or unclear",
"Meets benchmark": "β
Meets benchmark",
"Partially meets benchmark": "π‘ Partially meets benchmark",
"Needs work": "β Needs work",
"Lower signal": "β
Lower signal",
"Needs review": "π‘ Needs review",
}
def iconize(status: str) -> str:
return STATUS_ICONS.get(status, status)
APP_HEAD = """
<link rel="preconnect" href="https://fonts.googleapis.com">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link href="https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@500;600;700&display=swap" rel="stylesheet">
"""
APP_CSS = """
/* ===================== OpenStudy design system ===================== */
:root {
--os-paper: #eef4f2;
--os-card: #ffffff;
--os-ink: #172522;
--os-ink-soft: #4f6660;
--os-brand: #0e6b5f;
--os-brand-deep: #0a554b;
--os-brand-tint: #e0efeb;
--os-border: #d9e4e0;
--os-serif: "Space Grotesk", "Plus Jakarta Sans", ui-sans-serif, sans-serif;
--os-mono: "IBM Plex Mono", ui-monospace, SFMono-Regular, monospace;
}
.dark {
--os-paper: #101614;
--os-card: #19221f;
--os-ink: #e9e7df;
--os-ink-soft: #9fafa9;
--os-brand: #2fa08f;
--os-brand-deep: #3db2a0;
--os-brand-tint: #16302b;
--os-border: #2b3733;
}
body {
background: linear-gradient(180deg, #e0eeea 0%, var(--os-paper) 340px) fixed !important;
}
.dark body { background: var(--os-paper) !important; }
.gradio-container {
max-width: 1020px !important;
margin: 0 auto !important;
background: transparent !important;
}
/* Readability: roomier body text */
.gradio-container .prose p,
.gradio-container .prose li {
font-size: 0.98rem;
line-height: 1.62;
}
/* Hero CTA buttons: identical fixed size, side by side */
button.os-cta {
width: 280px !important;
min-width: 280px !important;
flex: 0 0 280px !important;
height: 48px;
white-space: nowrap;
font-weight: 600;
}
/* Action buttons keep their natural width instead of stretching */
button.os-action {
width: fit-content !important;
flex-grow: 0 !important;
align-self: flex-start;
min-width: 230px;
padding-left: 1.5rem !important;
padding-right: 1.5rem !important;
}
/* ---------- Scorecard ---------- */
.os-scorecard {
display: flex;
align-items: center;
gap: 0.65rem;
flex-wrap: wrap;
margin: 0.35rem 0 0.6rem;
}
.os-score-chip {
font-family: var(--os-mono);
font-weight: 700;
font-size: 1.18rem;
padding: 0.32rem 0.8rem;
border-radius: 10px;
color: #ffffff;
letter-spacing: -0.01em;
}
.os-chip-good { background: #0e6b5f; }
.os-chip-warn { background: #b45309; }
.os-chip-risk { background: #b91c1c; }
.os-score-level { font-weight: 650; font-size: 1.02rem; }
/* ---------- Standards verdict ---------- */
.os-verdict {
border: 1px solid var(--os-border);
border-radius: 10px;
padding: 0.85rem 1.05rem;
margin: 0.5rem 0 0.75rem;
font-size: 0.92rem;
line-height: 1.55;
}
.os-verdict ul { margin: 0.4rem 0 0 1.15rem; padding: 0; }
.os-verdict li { margin: 0.15rem 0; }
.os-verdict-pass {
background: #ecf6f1;
border-color: #bfe0d4;
color: #0a554b;
}
.dark .os-verdict-pass {
background: #14302a;
border-color: #265e51;
color: #9fd9cb;
}
.os-verdict-fail {
background: #fdf3ee;
border-color: #f0d4c4;
color: #9a3412;
}
.dark .os-verdict-fail {
background: #321d14;
border-color: #6b3a22;
color: #f0b893;
}
/* ---------- Hero header ---------- */
.os-hero {
padding: 2.1rem 0.2rem 1.5rem;
border-bottom: 1px solid var(--os-border);
margin-bottom: 0.35rem;
}
.os-wordmark {
font-family: var(--os-serif);
font-weight: 700;
font-size: 1.15rem;
letter-spacing: -0.01em;
color: var(--os-brand-deep);
}
.os-hero h1 {
font-family: var(--os-serif);
font-weight: 700;
font-size: clamp(1.6rem, 3.1vw, 2.25rem);
line-height: 1.18;
letter-spacing: -0.022em;
color: var(--os-ink);
max-width: 32ch;
margin: 0.9rem 0 0.6rem;
}
.os-lede {
color: var(--os-ink-soft);
font-size: 1.02rem;
line-height: 1.55;
max-width: 72ch;
margin: 0 0 1.05rem;
}
.os-badges {
display: flex;
flex-wrap: wrap;
gap: 0.45rem;
margin-bottom: 1.1rem;
}
.os-badge {
display: inline-flex;
align-items: center;
gap: 0.35rem;
padding: 0.28rem 0.72rem;
border: 1px solid var(--os-border);
border-radius: 999px;
background: var(--os-card);
color: var(--os-ink-soft);
font-size: 0.78rem;
font-weight: 600;
letter-spacing: 0.01em;
white-space: nowrap;
}
.os-badge.os-badge-brand {
border-color: transparent;
background: var(--os-brand-tint);
color: var(--os-brand-deep);
}
/* ---------- Callout note ---------- */
.os-note, .openstudy-note {
border: 1px solid var(--os-border);
border-left: 4px solid var(--os-brand);
padding: 0.85rem 1.05rem;
background: var(--os-card);
color: var(--os-ink);
border-radius: 10px;
font-size: 0.92rem;
line-height: 1.55;
max-width: 86ch;
}
.os-note strong { color: var(--os-brand-deep); }
/* ---------- Tabs as underlined nav ---------- */
.gradio-container button[role="tab"] {
font-weight: 600;
font-size: 0.95rem;
color: var(--os-ink-soft);
background: transparent;
border-radius: 6px 6px 0 0;
padding: 0.6rem 1rem;
border-bottom: 2px solid transparent;
}
.gradio-container button[role="tab"][aria-selected="true"] {
color: var(--os-brand-deep);
border-bottom: 2px solid var(--os-brand);
background: transparent;
}
.gradio-container .tabitem {
padding-top: 0.85rem;
border: none;
background: transparent;
}
/* ---------- Typography in markdown blocks ---------- */
.gradio-container .prose h1,
.gradio-container .prose h2,
.gradio-container .prose h3 {
font-family: var(--os-serif);
font-weight: 600;
letter-spacing: -0.01em;
color: var(--os-ink);
}
.gradio-container .prose code {
font-family: var(--os-mono);
font-size: 0.85em;
background: var(--os-brand-tint);
color: var(--os-brand-deep);
border-radius: 4px;
padding: 0.08em 0.35em;
}
/* ---------- Buttons ---------- */
.gradio-container button.primary,
.gradio-container button.secondary {
font-weight: 600;
letter-spacing: 0.01em;
transition: transform 0.08s ease, box-shadow 0.12s ease;
}
.gradio-container button.primary:hover {
box-shadow: 0 3px 10px rgba(14, 107, 95, 0.28);
}
.gradio-container button.primary:active,
.gradio-container button.secondary:active {
transform: translateY(1px);
}
/* ---------- Tables ---------- */
.gradio-container .table-wrap {
border: 1px solid var(--os-border);
border-radius: 10px;
}
.gradio-container thead th,
.gradio-container thead th span {
font-size: 0.72rem !important;
text-transform: uppercase;
letter-spacing: 0.07em;
font-weight: 700;
color: var(--os-ink-soft);
}
.gradio-container tbody td,
.gradio-container tbody td span {
font-size: 0.86rem;
line-height: 1.45;
}
.compact-table textarea { font-size: 0.88rem !important; }
/* ---------- Inputs ---------- */
.gradio-container input:focus,
.gradio-container textarea:focus {
border-color: var(--os-brand) !important;
box-shadow: 0 0 0 3px rgba(14, 107, 95, 0.14) !important;
}
/* ---------- Footer ---------- */
.os-footer {
display: flex;
flex-wrap: wrap;
justify-content: space-between;
gap: 0.5rem 1.5rem;
border-top: 1px solid var(--os-border);
margin-top: 2.2rem;
padding: 1.1rem 0.2rem 0.4rem;
color: var(--os-ink-soft);
font-size: 0.82rem;
}
.os-footer a { color: var(--os-brand); text-decoration: none; }
@media (max-width: 720px) {
.os-hero { padding-top: 1.4rem; }
.os-badge { font-size: 0.72rem; }
}
"""
def strip_markup(value: Any) -> str:
if not value:
return ""
text = str(value)
text = re.sub(r"<[^>]+>", " ", text)
text = html.unescape(text)
return normalize_space(text)
def normalize_space(text: str) -> str:
return re.sub(r"\s+", " ", text or "").strip()
def normalize_doi(value: str) -> str:
match = re.search(r"\b10\.\d{4,9}/[-._;()/:A-Z0-9]+\b", value or "", flags=re.I)
if not match:
return ""
return match.group(0).rstrip(".,;)]}").lower()
def is_url(value: str) -> bool:
return bool(re.match(r"^https?://", (value or "").strip(), flags=re.I))
def safe_get_json(url: str, params: dict[str, Any] | None = None) -> dict[str, Any]:
try:
response = requests.get(url, params=params, headers=HEADERS, timeout=REQUEST_TIMEOUT)
response.raise_for_status()
return response.json()
except Exception:
return {}
def get_first(value: Any) -> str:
if isinstance(value, list) and value:
return strip_markup(value[0])
return strip_markup(value)
def year_from_crossref(item: dict[str, Any]) -> str:
for key in ("published-print", "published-online", "published", "issued", "created"):
parts = item.get(key, {}).get("date-parts", [])
if parts and parts[0]:
return str(parts[0][0])
return ""
def record_from_crossref(item: dict[str, Any]) -> dict[str, Any]:
title = get_first(item.get("title"))
container = get_first(item.get("container-title"))
abstract = strip_markup(item.get("abstract"))
doi = strip_markup(item.get("DOI")).lower()
authors = []
for author in item.get("author", [])[:8]:
name = normalize_space(" ".join(part for part in (author.get("given"), author.get("family")) if part))
if name:
authors.append(name)
return {
"title": title or "Untitled study",
"year": year_from_crossref(item),
"venue": container,
"doi": doi,
"url": item.get("URL", ""),
"abstract": abstract,
"authors": ", ".join(authors),
"source": "Crossref",
}
def crossref_by_doi(doi: str) -> dict[str, Any] | None:
url = f"https://api.crossref.org/works/{quote(doi, safe='')}"
data = safe_get_json(url)
item = data.get("message")
if isinstance(item, dict):
return record_from_crossref(item)
return None
def crossref_search(query: str, rows: int) -> list[dict[str, Any]]:
data = safe_get_json(
"https://api.crossref.org/works",
params={"query.bibliographic": query, "rows": rows, "select": "title,DOI,URL,abstract,author,container-title,published,published-print,published-online,issued,created"},
)
items = data.get("message", {}).get("items", [])
return [record_from_crossref(item) for item in items if isinstance(item, dict)]
def abstract_from_openalex(index: dict[str, list[int]] | None) -> str:
if not index:
return ""
positions: dict[int, str] = {}
for word, offsets in index.items():
for offset in offsets:
positions[int(offset)] = word
return normalize_space(" ".join(positions[i] for i in sorted(positions)))
def record_from_openalex(item: dict[str, Any]) -> dict[str, Any]:
primary = item.get("primary_location") or {}
source = primary.get("source") or {}
doi = (item.get("doi") or "").replace("https://doi.org/", "").lower()
authors = []
for authorship in item.get("authorships", [])[:8]:
author = authorship.get("author", {})
name = strip_markup(author.get("display_name"))
if name:
authors.append(name)
return {
"title": strip_markup(item.get("display_name")) or "Untitled study",
"year": str(item.get("publication_year") or ""),
"venue": strip_markup(source.get("display_name")),
"doi": doi,
"url": item.get("doi") or item.get("id") or "",
"abstract": abstract_from_openalex(item.get("abstract_inverted_index")),
"authors": ", ".join(authors),
"source": "OpenAlex",
}
def openalex_by_doi(doi: str) -> dict[str, Any] | None:
url = f"https://api.openalex.org/works/https://doi.org/{doi}"
data = safe_get_json(url)
if data.get("id"):
return record_from_openalex(data)
return None
def openalex_search(query: str, rows: int) -> list[dict[str, Any]]:
data = safe_get_json("https://api.openalex.org/works", params={"search": query, "per-page": rows})
items = data.get("results", [])
return [record_from_openalex(item) for item in items if isinstance(item, dict)]
def extract_page_record(url: str) -> dict[str, Any] | None:
try:
response = requests.get(url, headers=HEADERS, timeout=REQUEST_TIMEOUT)
response.raise_for_status()
except Exception:
return None
content_type = response.headers.get("content-type", "").lower()
if "pdf" in content_type or url.lower().endswith(".pdf"):
with tempfile.NamedTemporaryFile(delete=False, suffix=".pdf") as tmp:
tmp.write(response.content)
tmp_path = tmp.name
text = extract_text_from_file(tmp_path)
return {
"title": Path(url).name or "Uploaded PDF from URL",
"year": "",
"venue": "",
"doi": normalize_doi(text),
"url": url,
"abstract": text[:6000],
"authors": "",
"source": "PDF URL",
}
soup = BeautifulSoup(response.text, "html.parser")
def meta_content(*names: str) -> str:
for name in names:
tag = soup.find("meta", attrs={"name": name}) or soup.find("meta", attrs={"property": name})
if tag and tag.get("content"):
return strip_markup(tag.get("content"))
return ""
title = meta_content("citation_title", "dc.title", "og:title") or strip_markup(soup.title.string if soup.title else "")
abstract = meta_content("citation_abstract", "dc.description", "description", "og:description")
doi = meta_content("citation_doi", "dc.identifier") or normalize_doi(response.text)
year = meta_content("citation_publication_date", "citation_online_date")[:4]
venue = meta_content("citation_journal_title", "citation_conference_title")
if doi:
richer = crossref_by_doi(doi) or openalex_by_doi(doi)
if richer:
if not richer.get("abstract") and abstract:
richer["abstract"] = abstract
richer["source"] = f"{richer['source']} + page"
return richer
return {
"title": title or url,
"year": year,
"venue": venue,
"doi": doi.lower(),
"url": url,
"abstract": abstract,
"authors": "",
"source": "Web page",
}
def merge_records(records: list[dict[str, Any]], limit: int) -> list[dict[str, Any]]:
merged: dict[str, dict[str, Any]] = {}
for record in records:
if not record:
continue
doi = normalize_doi(record.get("doi", ""))
title_key = re.sub(r"[^a-z0-9]+", "", (record.get("title") or "").lower())[:90]
key = doi or title_key
if not key:
continue
if key not in merged:
merged[key] = record
continue
existing = merged[key]
for field in ("title", "year", "venue", "doi", "url", "authors"):
if not existing.get(field) and record.get(field):
existing[field] = record[field]
if len(record.get("abstract", "")) > len(existing.get("abstract", "")):
existing["abstract"] = record["abstract"]
sources = {part.strip() for part in existing.get("source", "").split("+") if part.strip()}
sources.update(part.strip() for part in record.get("source", "").split("+") if part.strip())
existing["source"] = " + ".join(sorted(sources))
return list(merged.values())[:limit]
def search_studies(query: str, rows: int) -> list[dict[str, Any]]:
query = normalize_space(query)
if not query:
return []
requested_rows = max(1, min(int(rows), MAX_TOPIC_PAPERS))
records: list[dict[str, Any]] = []
doi = normalize_doi(query)
if doi:
records.extend(record for record in (crossref_by_doi(doi), openalex_by_doi(doi)) if record)
if records:
return merge_records(records, requested_rows)
if is_url(query) and not records:
page_record = extract_page_record(query)
if page_record:
records.append(page_record)
return merge_records(records, requested_rows)
target_rows = max(requested_rows, MIN_TOPIC_PAPERS)
api_rows = min(max(target_rows * 2, MIN_TOPIC_PAPERS), MAX_TOPIC_PAPERS)
if not records or len(records) < target_rows:
records.extend(crossref_search(query, api_rows))
records.extend(openalex_search(query, api_rows))
return merge_records(records, target_rows)
def detect_study_type(text: str) -> tuple[str, str]:
lowered = text.lower()
scores = {
"review": count_patterns(lowered, (r"\bsystematic review\b", r"\bmeta[- ]analysis\b", r"\bprisma\b")),
"clinical_trial": count_patterns(lowered, (r"\brandomi[sz]ed controlled trial\b", r"\bclinical trial\b", r"\btrial registration\b", r"\bplacebo\b")),
"observational": count_patterns(lowered, (r"\bcohort\b", r"\bcase[- ]control\b", r"\bcross[- ]sectional\b", r"\bretrospective\b", r"\bprospective observational\b")),
"qualitative": count_patterns(lowered, (r"\bqualitative\b", r"\binterviews?\b", r"\bfocus groups?\b", r"\bthematic analysis\b")),
"animal": count_patterns(lowered, (r"\bmice\b", r"\brats?\b", r"\banimal model\b", r"\biacuc\b", r"\banimal care\b")),
"ml": count_patterns(lowered, (r"\bmachine learning\b", r"\bdeep learning\b", r"\bprediction model\b", r"\balgorithm\b", r"\bclassifier\b")),
"survey": count_patterns(lowered, (r"\bsurvey\b", r"\bquestionnaire\b", r"\brespondents\b")),
}
best_key, best_score = max(scores.items(), key=lambda item: item[1])
labels = {
"review": "Systematic review or meta-analysis",
"clinical_trial": "Clinical trial",
"observational": "Observational study",
"qualitative": "Qualitative study",
"animal": "Animal or preclinical study",
"ml": "Model or algorithm study",
"survey": "Survey study",
"unknown": "Not enough text to classify",
}
if best_score <= 0:
return "unknown", labels["unknown"]
return best_key, labels[best_key]
def count_patterns(text: str, patterns: tuple[str, ...]) -> int:
return sum(1 for pattern in patterns if re.search(pattern, text, flags=re.I))
def criterion_applies(criterion: Criterion, study_key: str) -> bool:
if study_key in criterion.excludes:
return False
if criterion.applies_to:
return study_key in criterion.applies_to
return True
def benchmark_applies(benchmark: Benchmark, study_key: str) -> bool:
if study_key in benchmark.excludes:
return False
if benchmark.applies_to:
return study_key in benchmark.applies_to
return True
def split_sentences(text: str) -> list[str]:
normalized = normalize_space(text)
pieces = re.split(r"(?<=[.!?])\s+(?=[A-Z0-9])", normalized)
if len(pieces) <= 1:
pieces = re.split(r"\s{2,}", normalized)
return [piece.strip() for piece in pieces if piece.strip()]
def find_snippet(text: str, patterns: tuple[str, ...], max_chars: int = 260) -> str:
sentences = split_sentences(text[:MAX_ANALYSIS_CHARS])
for sentence in sentences:
for pattern in patterns:
if re.search(pattern, sentence, flags=re.I):
return truncate(sentence, max_chars)
for pattern in patterns:
match = re.search(pattern, text, flags=re.I)
if match:
start = max(0, match.start() - max_chars // 2)
end = min(len(text), match.end() + max_chars // 2)
return truncate(normalize_space(text[start:end]), max_chars)
return ""
def truncate(text: str, max_chars: int) -> str:
text = normalize_space(text)
if len(text) <= max_chars:
return text
return text[: max_chars - 3].rstrip() + "..."
def evaluate_criterion(text: str, criterion: Criterion) -> dict[str, Any]:
positive_hit = any(re.search(pattern, text, flags=re.I) for pattern in criterion.positive)
concern_hit = any(re.search(pattern, text, flags=re.I) for pattern in criterion.concern)
if positive_hit:
status = "Reported"
score = 1.0
evidence = find_snippet(text, criterion.positive)
elif concern_hit:
status = "Potential concern"
score = 0.25
evidence = find_snippet(text, criterion.concern)
else:
status = "Missing or unclear"
score = 0.0
evidence = ""
return {
"category": criterion.category,
"criterion": criterion.label,
"status": status,
"score": score,
"evidence": evidence,
"recommendation": criterion.recommendation,
}
def category_scores(results: list[dict[str, Any]]) -> dict[str, float]:
grouped: dict[str, list[float]] = {}
for result in results:
grouped.setdefault(result["category"], []).append(float(result["score"]))
return {category: round(sum(values) / len(values) * 100, 1) for category, values in grouped.items()}
def risk_level(score: float, thresholds: tuple[float, float] = DEFAULT_RISK_THRESHOLDS) -> tuple[str, str]:
moderate_at, lower_at = thresholds
if score >= lower_at:
return "Lower reporting risk", "The available text reports many safeguards readers expect."
if score >= moderate_at:
return "Moderate reporting risk", "Several safeguards are reported, but important items need review."
return "Higher reporting risk", "Many expected safeguards are missing or unclear in the available text."
def evaluate_study_text(
text: str,
metadata: dict[str, Any] | None = None,
scope: str = "available text",
forced_study_key: str | None = None,
risk_thresholds: tuple[float, float] = DEFAULT_RISK_THRESHOLDS,
) -> dict[str, Any]:
metadata = metadata or {}
text = normalize_space(text)
truncated = len(text) > MAX_ANALYSIS_CHARS
analysis_text = text[:MAX_ANALYSIS_CHARS]
detected_key, detected_label = detect_study_type(analysis_text)
study_key = forced_study_key or detected_key
study_label = label_for_study_key(study_key) if forced_study_key else detected_label
criteria = [criterion for criterion in CRITERIA if criterion_applies(criterion, study_key)]
checklist = [evaluate_criterion(analysis_text, criterion) for criterion in criteria]
scores = category_scores(checklist)
overall = round(sum(item["score"] for item in checklist) / max(len(checklist), 1) * 100, 1)
level, level_detail = risk_level(overall, risk_thresholds)
conducted = extract_conduct_summary(analysis_text, metadata, study_label)
benchmarks = build_benchmark_rows(checklist, study_key)
biases = build_bias_rows(checklist, study_key)
return {
"metadata": metadata,
"scope": scope,
"study_key": study_key,
"study_label": study_label,
"checklist": checklist,
"scores": scores,
"overall": overall,
"level": level,
"level_detail": level_detail,
"conducted": conducted,
"benchmarks": benchmarks,
"biases": biases,
"truncated": truncated,
"text_chars": len(text),
"analysis_text": analysis_text,
"risk_thresholds": risk_thresholds,
}
def label_for_study_key(study_key: str) -> str:
labels = {
"review": "Systematic review or meta-analysis",
"clinical_trial": "Clinical trial",
"observational": "Observational study",
"qualitative": "Qualitative study",
"animal": "Animal or preclinical study",
"ml": "Model or algorithm study",
"survey": "Survey study",
"unknown": "Not enough text to classify",
}
return labels.get(study_key, labels["unknown"])
def key_for_type_hint(type_hint: str) -> str | None:
mapping = {
"Clinical trial": "clinical_trial",
"Observational study": "observational",
"Systematic review or meta-analysis": "review",
"Qualitative study": "qualitative",
"Survey study": "survey",
"Animal or preclinical study": "animal",
"Model or algorithm study": "ml",
}
return mapping.get(type_hint or "")
def extract_conduct_summary(text: str, metadata: dict[str, Any], study_label: str) -> list[tuple[str, str]]:
fields = [
("Title", metadata.get("title") or find_snippet(text, (r"^.{20,180}",), 180)),
("Detected study type", study_label),
]
if metadata.get("project_status"):
fields.append(("Project status", metadata["project_status"]))
if metadata.get("team"):
fields.append(("Team or owner", metadata["team"]))
fields.extend(
[
("Authors", metadata.get("authors", "")),
("Publication", " ".join(part for part in (metadata.get("venue"), metadata.get("year")) if part)),
("DOI or URL", metadata.get("doi") or metadata.get("url", "")),
("Population or sample", find_snippet(text, (r"\bparticipants?\b", r"\bpatients?\b", r"\bsample\b", r"\bcohort\b", r"\brecruited\b", r"\benrolled\b"))),
("Intervention, exposure, or focus", find_snippet(text, (r"\bintervention\b", r"\btreatment\b", r"\bexposure\b", r"\bprogram\b", r"\bassigned\b", r"\bassociation between\b"))),
("Comparator or control", find_snippet(text, (r"\bcontrol group\b", r"\bcomparator\b", r"\bplacebo\b", r"\busual care\b", r"\bmatched controls?\b"))),
("Outcomes or endpoints", find_snippet(text, (r"\bprimary outcome\b", r"\bendpoint\b", r"\boutcome measures?\b", r"\bmeasured\b"))),
("Analysis approach", find_snippet(text, (r"\bregression\b", r"\banova\b", r"\bodds ratio\b", r"\bhazard ratio\b", r"\bconfidence interval\b", r"\bmodel\b"))),
("Ethics or consent", find_snippet(text, (r"\bethics\b", r"\birb\b", r"\binformed consent\b", r"\bconsent\b", r"\bdeclaration of helsinki\b"))),
("Funding or conflicts", find_snippet(text, (r"\bfunding\b", r"\bgrant\b", r"\bsponsor\b", r"\bconflict", r"\bcompeting interests?\b"))),
]
)
return [(label, value or "Not found in available text") for label, value in fields]
def checklist_lookup(checklist: list[dict[str, Any]]) -> dict[str, dict[str, Any]]:
return {item["criterion"]: item for item in checklist}
def combine_evidence(items: list[dict[str, Any]]) -> str:
snippets = [item["evidence"] for item in items if item.get("evidence")]
if snippets:
return " | ".join(snippets[:2])
missing = [item["criterion"] for item in items if item.get("status") == "Missing or unclear"]
if missing:
return "Missing or unclear: " + "; ".join(missing[:3])
return "No strong concern found in available text"
def bias_status(items: list[dict[str, Any]]) -> str:
statuses = [item.get("status") for item in items]
if any(status == "Potential concern" for status in statuses):
return "Potential concern"
if all(status == "Reported" for status in statuses if status):
return "Lower signal"
return "Needs review"
def benchmark_status(score: float) -> str:
if score >= 0.85:
return "Meets benchmark"
if score >= 0.55:
return "Partially meets benchmark"
return "Needs work"
def build_benchmark_rows(checklist: list[dict[str, Any]], study_key: str) -> list[list[str]]:
lookup = checklist_lookup(checklist)
rows = []
for benchmark in BENCHMARKS:
if not benchmark_applies(benchmark, study_key):
continue
items = [lookup[label] for label in benchmark.criteria if label in lookup]
if not items:
continue
score = sum(float(item["score"]) for item in items) / len(items)
missing = [item["criterion"] for item in items if item["status"] != "Reported"]
action = "Maintain this benchmark and keep evidence in the protocol or report."
if missing:
action = "Address: " + "; ".join(missing[:4])
rows.append(
[
benchmark.name,
iconize(benchmark_status(score)),
f"{score * 100:.0f}%",
benchmark.description,
combine_evidence(items),
action,
]
)
return rows
def build_bias_rows(checklist: list[dict[str, Any]], study_key: str) -> list[list[str]]:
lookup = checklist_lookup(checklist)
def pick(*labels: str) -> list[dict[str, Any]]:
return [lookup[label] for label in labels if label in lookup]
rows = [
[
"Selection bias",
bias_status(pick("Eligibility criteria are described", "Recruitment source or study period is described", "Participant characteristics are reported")),
combine_evidence(pick("Eligibility criteria are described", "Recruitment source or study period is described", "Participant characteristics are reported")),
"Review whether the sample represents the target population and whether exclusions could skew results.",
],
[
"Reporting bias",
bias_status(pick("Protocol or preregistration is reported", "Primary outcomes or endpoints are specified", "Limitations are discussed")),
combine_evidence(pick("Protocol or preregistration is reported", "Primary outcomes or endpoints are specified", "Limitations are discussed")),
"Check for preregistration, outcome switching, selective reporting, and absent limitations.",
],
[
"Funding or conflict bias",
bias_status(pick("Funding source is reported", "Conflicts or competing interests are reported", "Funder or sponsor role is clarified")),
combine_evidence(pick("Funding source is reported", "Conflicts or competing interests are reported", "Funder or sponsor role is clarified")),
"Check whether funders or sponsors influenced design, analysis, interpretation, or publication.",
],
[
"Ethics safeguards",
bias_status(pick("Ethics approval or oversight is reported", "Consent process is reported", "Privacy, confidentiality, or safety safeguards are reported", "Animal welfare oversight is reported")),
combine_evidence(pick("Ethics approval or oversight is reported", "Consent process is reported", "Privacy, confidentiality, or safety safeguards are reported", "Animal welfare oversight is reported")),
"Confirm oversight, consent or waiver, privacy protections, and participant or animal welfare safeguards.",
],
[
"Measurement bias",
bias_status(pick("Measurement validity or reliability is addressed", "Blinding or masking is reported")),
combine_evidence(pick("Measurement validity or reliability is addressed", "Blinding or masking is reported")),
"Check whether outcomes were measured with valid instruments and protected from assessor expectations.",
],
[
"Attrition or missing-data bias",
bias_status(pick("Missing data, attrition, or follow-up is addressed")),
combine_evidence(pick("Missing data, attrition, or follow-up is addressed")),
"Look for lost-to-follow-up counts, exclusions after enrollment, imputation, and sensitivity checks.",
],
]
if study_key in {"observational", "survey", "unknown"}:
rows.append(
[
"Confounding",
bias_status(pick("Confounding is addressed", "Causal claims are appropriately constrained")),
combine_evidence(pick("Confounding is addressed", "Causal claims are appropriately constrained")),
"For non-randomized designs, check whether major confounders were identified and adjusted.",
]
)
if study_key == "clinical_trial":
rows.append(
[
"Performance and detection bias",
bias_status(pick("Random allocation is reported", "Blinding or masking is reported", "Comparator or control condition is described")),
combine_evidence(pick("Random allocation is reported", "Blinding or masking is reported", "Comparator or control condition is described")),
"Confirm allocation concealment, blinding, and comparator details.",
]
)
if study_key == "review":
rows.append(
[
"Review publication bias",
bias_status(pick("Search strategy and databases are reported", "Risk-of-bias or quality appraisal is reported", "Publication bias is considered")),
combine_evidence(pick("Search strategy and databases are reported", "Risk-of-bias or quality appraisal is reported", "Publication bias is considered")),
"Review search completeness, included-study appraisal, and publication-bias assessment.",
]
)
if study_key == "ml":
rows.append(
[
"Algorithmic bias",
bias_status(pick("Validation split or external validation is reported", "Fairness or subgroup performance is reported", "Participant characteristics are reported")),
combine_evidence(pick("Validation split or external validation is reported", "Fairness or subgroup performance is reported", "Participant characteristics are reported")),
"Check subgroup performance, external validation, leakage, and whether affected groups are represented.",
]
)
return [[row[0], iconize(row[1]), *row[2:]] for row in rows]
def style_plot(fig, ax) -> None:
fig.patch.set_facecolor(CARD)
ax.set_facecolor(CARD)
for spine in ax.spines.values():
spine.set_visible(False)
ax.tick_params(colors=INK, length=0, labelsize=9.5)
def score_plot(scores: dict[str, float], thresholds: tuple[float, float] = DEFAULT_RISK_THRESHOLDS):
fig, ax = plt.subplots(figsize=(8.5, max(3.2, 0.42 * len(scores))))
style_plot(fig, ax)
if not scores:
ax.text(0.5, 0.5, "No scores available", ha="center", va="center", color=INK_SOFT)
ax.axis("off")
return fig
moderate_at, lower_at = thresholds
ordered = sorted(scores.items(), key=lambda item: item[1])
labels = [item[0] for item in ordered]
values = [item[1] for item in ordered]
colors = [RISK if value < moderate_at else WARN if value < lower_at else BRAND for value in values]
ax.barh(labels, values, color=colors, height=0.62, zorder=3)
ax.barh(labels, [100] * len(values), color=BORDER, height=0.62, zorder=1, alpha=0.45)
ax.set_xlim(0, 100)
ax.set_xlabel("Reported safeguard score", color=INK_SOFT, fontsize=9.5)
ax.grid(axis="x", color=BORDER, linewidth=0.8, zorder=0)
for index, value in enumerate(values):
inside = value > 88
ax.text(
value - 2 if inside else value + 1.5,
index,
f"{value:.0f}%",
va="center",
ha="right" if inside else "left",
fontsize=9,
fontweight="bold",
color="#ffffff" if inside else INK,
zorder=4,
)
ax.set_title("Reporting safeguards by category", loc="left", color=INK, fontsize=11, fontweight="bold", pad=12)
fig.tight_layout()
return fig
def user_standards_markdown(
report: dict[str, Any],
categories: list[str] | None,
required: list[str] | None,
min_score: float,
terms: str,
) -> str:
categories = [cat for cat in (categories or []) if cat in STANDARD_CATEGORIES]
required = list(required or [])
term_list = [term.strip() for term in (terms or "").split(",") if term.strip()]
scores = report.get("scores", {})
chosen = {cat: scores[cat] for cat in categories if cat in scores}
if chosen:
user_score = round(sum(chosen.values()) / len(chosen), 1)
score_scope = ", ".join(chosen)
else:
user_score = report.get("overall", 0.0)
score_scope = "all categories"
status_by_label = {item.get("criterion"): item.get("status") for item in report.get("checklist", [])}
failures: list[str] = []
notes: list[str] = []
if user_score < float(min_score):
failures.append(
f"Safeguard score is {user_score:.1f}, below your minimum of {float(min_score):.0f} (scored on: {score_scope})."
)
for label in required:
if label not in status_by_label:
notes.append(f"“{html.escape(label)}” was not checked for this study type.")
elif status_by_label[label] != "Reported":
failures.append(f"Required safeguard not reported: {html.escape(label)}.")
haystack = (report.get("analysis_text") or "").lower()
for term in term_list:
if term.lower() not in haystack:
failures.append(f"Required term not found in the text: “{html.escape(term)}”.")
if failures:
items = "".join(f"<li>{item}</li>" for item in failures + notes)
return (
f'<div class="os-verdict os-verdict-fail"><strong>Does not meet your standards</strong> '
f"({len(failures)} unmet requirement{'s' if len(failures) != 1 else ''})."
f"<ul>{items}</ul></div>"
)
detail = f"Score {user_score:.1f} ≥ your minimum of {float(min_score):.0f} (scored on: {score_scope})"
if required:
detail += f"; all {len(required)} required safeguards reported"
if term_list:
detail += f"; all {len(term_list)} required terms found"
note_items = "".join(f"<li>{item}</li>" for item in notes)
note_html = f"<ul>{note_items}</ul>" if note_items else ""
return (
f'<div class="os-verdict os-verdict-pass"><strong>Meets your standards.</strong> '
f"{detail}.{note_html}</div>"
)
def summary_markdown(report: dict[str, Any]) -> str:
metadata = report["metadata"]
title = metadata.get("title") or "Untitled study"
caution = " This upload was truncated for analysis." if report["truncated"] else ""
moderate_at, lower_at = report.get("risk_thresholds", DEFAULT_RISK_THRESHOLDS)
overall = report["overall"]
tier = "good" if overall >= lower_at else "warn" if overall >= moderate_at else "risk"
return f"""
### {strip_markup(title)}
<div class="os-scorecard">
<span class="os-score-chip os-chip-{tier}">{overall:.0f}/100</span>
<span class="os-score-level">{report['level']}</span>
</div>
{report['level_detail']}
**What this score means:** {overall:.0f}% of the reporting safeguards expected for a
{report['study_label'].lower()} were found in the text reviewed. It measures how completely the
study is *reported*, not whether its findings are true. This is a transparent screening of the
**{report['scope']}**, not proof that the research is ethical, unethical, biased, or unbiased.{caution}
**Detected study type:** {report['study_label']}
**Text reviewed:** {report['text_chars']:,} characters
"""
def conduct_markdown(report: dict[str, Any]) -> str:
rows = report["conducted"]
body = "\n".join(f"- **{label}:** {value}" for label, value in rows if value)
return "### How the study appears to have been conducted\n" + body
def checklist_rows(report: dict[str, Any]) -> list[list[str]]:
return [
[
item["category"],
item["criterion"],
iconize(item["status"]),
item["evidence"] or "Not found in available text",
item["recommendation"],
]
for item in report["checklist"]
]
def report_to_markdown(report: dict[str, Any]) -> str:
lines = [
f"# {APP_NAME} screening report",
"",
summary_markdown(report).strip(),
"",
conduct_markdown(report).strip(),
"",
"## Benchmarks",
"",
"| Benchmark | Status | Score | Description | Evidence | Required action |",
"| --- | --- | --- | --- | --- | --- |",
]
for benchmark, status, score, description, evidence, action in report.get("benchmarks", []):
lines.append(
f"| {escape_table(benchmark)} | {escape_table(status)} | {escape_table(score)} | {escape_table(description)} | {escape_table(evidence)} | {escape_table(action)} |"
)
lines.extend(
[
"",
"## Potential bias and ethics signals",
"",
"| Signal | Status | Evidence | Next check |",
"| --- | --- | --- | --- |",
]
)
for signal, status, evidence, next_check in report["biases"]:
lines.append(f"| {escape_table(signal)} | {escape_table(status)} | {escape_table(evidence)} | {escape_table(next_check)} |")
lines.extend(
[
"",
"## Checklist",
"",
"| Category | Criterion | Status | Evidence | Recommendation |",
"| --- | --- | --- | --- | --- |",
]
)
for row in checklist_rows(report):
lines.append("| " + " | ".join(escape_table(value) for value in row) + " |")
lines.extend(
[
"",
"## Important limitation",
"",
"This report screens reported safeguards in the text supplied to the app. It does not replace peer review, domain expert review, IRB review, legal advice, or replication.",
]
)
return "\n".join(lines)
def escape_table(value: Any) -> str:
return normalize_space(str(value)).replace("|", "\\|")
def write_report_file(report: dict[str, Any]) -> str:
with tempfile.NamedTemporaryFile("w", delete=False, suffix=".md", encoding="utf-8") as handle:
handle.write(report_to_markdown(report))
return handle.name
def format_choice(index: int, record: dict[str, Any]) -> str:
year = f" ({record.get('year')})" if record.get("year") else ""
title = truncate(record.get("title") or "Untitled study", 88)
return f"{index + 1}. {title}{year}"
def search_studies_ui(query: str, rows: int):
records = search_studies(query, int(rows or DEFAULT_TOPIC_PAPERS))
table = []
for index, record in enumerate(records, start=1):
table.append(
[
index,
record.get("title", ""),
record.get("year", ""),
record.get("venue", ""),
record.get("doi", ""),
record.get("source", ""),
truncate(record.get("abstract", ""), 260) or "No abstract found",
]
)
choices = [format_choice(index, record) for index, record in enumerate(records)]
doi = normalize_doi(query)
exact_lookup = bool(doi or is_url(query))
expected_count = MIN_TOPIC_PAPERS if not exact_lookup else 1
status = (
f"Found {len(records)} candidate studies. **Click a row** to evaluate it against your standards."
if records
else "No candidate studies found. Try a DOI, a more exact title, or paste an abstract in the Add your study tab."
)
if records and not exact_lookup and len(records) < expected_count:
status += f" Public metadata sources returned fewer than the {MIN_TOPIC_PAPERS}-paper minimum for this topic."
elif records and not exact_lookup:
status += f" Topic searches return at least {MIN_TOPIC_PAPERS} papers when available."
return table, gr.update(choices=choices, value=choices[0] if choices else None), records, status
def clean_thresholds(moderate_at: float, lower_at: float) -> tuple[float, float]:
moderate_at = float(moderate_at)
lower_at = float(lower_at)
if moderate_at > lower_at:
moderate_at, lower_at = lower_at, moderate_at
return moderate_at, lower_at
def analyze_search_record(
record: dict[str, Any],
risk_thresholds: tuple[float, float] = DEFAULT_RISK_THRESHOLDS,
) -> dict[str, Any] | None:
text_parts = [record.get("title", ""), record.get("abstract", "")]
if not normalize_space(" ".join(text_parts)):
return None
return evaluate_study_text(
" ".join(text_parts),
record,
scope="metadata and abstract available from public search",
risk_thresholds=risk_thresholds,
)
def analyze_selected_ui(
choice: str,
records: list[dict[str, Any]] | None,
std_categories: list[str] | None = None,
std_required: list[str] | None = None,
std_min_score: float = 0,
std_terms: str = "",
std_risk_moderate: float = DEFAULT_RISK_THRESHOLDS[0],
std_risk_lower: float = DEFAULT_RISK_THRESHOLDS[1],
):
records = records or []
if not choice or not records:
return empty_outputs("Search for studies first, then select a result.")
match = re.match(r"^(\d+)\.", choice)
index = int(match.group(1)) - 1 if match else 0
if index < 0 or index >= len(records):
return empty_outputs("Selected study was not found in the current search results.")
report = analyze_search_record(records[index], clean_thresholds(std_risk_moderate, std_risk_lower))
if report is None:
return empty_outputs("That result does not include enough text to evaluate. Paste the abstract or add the paper in the Add your study tab.")
return report_outputs(report, user_standards_markdown(report, std_categories, std_required, std_min_score, std_terms))
def select_result_ui(
records: list[dict[str, Any]] | None,
std_categories: list[str] | None,
std_required: list[str] | None,
std_min_score: float,
std_terms: str,
std_risk_moderate: float,
std_risk_lower: float,
evt: gr.SelectData,
):
records = records or []
index = evt.index[0] if isinstance(evt.index, (list, tuple)) else int(evt.index)
if index < 0 or index >= len(records):
return (gr.update(), *empty_outputs("Search for studies first, then click a result row."))
record = records[index]
choice = format_choice(index, record)
report = analyze_search_record(record, clean_thresholds(std_risk_moderate, std_risk_lower))
if report is None:
return (
gr.update(value=choice),
*empty_outputs("That result does not include enough text to evaluate. Paste the abstract or add the paper in the Add your study tab."),
)
return (
gr.update(value=choice),
*report_outputs(report, user_standards_markdown(report, std_categories, std_required, std_min_score, std_terms)),
)
def uploaded_file_text(file_path: Any) -> tuple[str, str]:
if file_path:
path = file_path
if isinstance(file_path, dict):
path = file_path.get("path") or file_path.get("name")
elif hasattr(file_path, "name"):
path = file_path.name
return Path(str(path)).name, extract_text_from_file(str(path))
return "pasted text", ""
def analyze_upload_ui(
file_path: Any,
pasted_text: str,
title: str,
study_type_hint: str,
std_categories: list[str] | None = None,
std_required: list[str] | None = None,
std_min_score: float = 0,
std_terms: str = "",
std_risk_moderate: float = DEFAULT_RISK_THRESHOLDS[0],
std_risk_lower: float = DEFAULT_RISK_THRESHOLDS[1],
):
source_name, extracted = uploaded_file_text(file_path)
text = normalize_space(" ".join(part for part in (title, pasted_text, extracted) if part))
if not text:
return empty_outputs("Upload a PDF/text file or paste manuscript text to evaluate.")
metadata = {"title": title or source_name, "source": source_name}
report = evaluate_study_text(
text,
metadata,
scope="uploaded or pasted manuscript text",
forced_study_key=key_for_type_hint(study_type_hint),
risk_thresholds=clean_thresholds(std_risk_moderate, std_risk_lower),
)
return report_outputs(report, user_standards_markdown(report, std_categories, std_required, std_min_score, std_terms))
def project_text_from_fields(
uploaded_project_text: str,
title: str,
team: str,
project_status: str,
study_type_hint: str,
research_question: str,
study_design: str,
participants: str,
recruitment: str,
eligibility: str,
intervention_or_exposure: str,
comparator: str,
outcomes: str,
sample_size: str,
bias_controls: str,
ethics_plan: str,
consent_privacy: str,
analysis_plan: str,
missing_data_plan: str,
transparency_plan: str,
funding_conflicts: str,
notes: str,
) -> str:
fields = [
("Uploaded project or protocol file text", uploaded_project_text),
("Project title", title),
("Team or owner", team),
("Project status", project_status),
("Study type", study_type_hint if study_type_hint != "Auto-detect" else ""),
("Research question", research_question),
("Study design", study_design),
("Population or sample", participants),
("Recruitment source and study period", recruitment),
("Inclusion and exclusion criteria", eligibility),
("Intervention, exposure, or focus", intervention_or_exposure),
("Comparator or control", comparator),
("Primary and secondary outcomes", outcomes),
("Sample size or power rationale", sample_size),
("Bias controls", bias_controls),
("Ethics approval and oversight", ethics_plan),
("Consent, privacy, and safety safeguards", consent_privacy),
("Statistical or qualitative analysis plan", analysis_plan),
("Missing data, attrition, or follow-up plan", missing_data_plan),
("Data, code, materials, and preregistration plan", transparency_plan),
("Funding, sponsor role, and conflicts of interest", funding_conflicts),
("Additional notes", notes),
]
return "\n\n".join(f"{label}: {value}" for label, value in fields if normalize_space(value))
def top_project_gaps(report: dict[str, Any], limit: int = 4) -> str:
priority_statuses = {"Potential concern", "Missing or unclear"}
gaps = [
item["criterion"]
for item in report["checklist"]
if item.get("status") in priority_statuses
]
return "; ".join(gaps[:limit]) if gaps else "No major gaps flagged"
def project_table_rows(projects: list[dict[str, Any]] | None) -> list[list[Any]]:
rows = []
for index, project in enumerate(projects or [], start=1):
report = project.get("report", {})
rows.append(
[
index,
project.get("title", "Untitled project"),
report.get("study_label", project.get("study_type", "")),
project.get("project_status", ""),
f"{report.get('overall', 0):.1f}",
report.get("level", ""),
top_project_gaps(report, limit=3) if report else "",
]
)
return rows
def project_choices(projects: list[dict[str, Any]] | None) -> list[str]:
choices = []
for index, project in enumerate(projects or [], start=1):
title = truncate(project.get("title") or "Untitled project", 80)
choices.append(f"{index}. {title}")
return choices
def make_project_record(
file_path: Any,
title: str,
team: str,
project_status: str,
study_type_hint: str,
research_question: str,
study_design: str,
participants: str,
recruitment: str,
eligibility: str,
intervention_or_exposure: str,
comparator: str,
outcomes: str,
sample_size: str,
bias_controls: str,
ethics_plan: str,
consent_privacy: str,
analysis_plan: str,
missing_data_plan: str,
transparency_plan: str,
funding_conflicts: str,
notes: str,
) -> dict[str, Any] | None:
source_name, uploaded_project_text = uploaded_file_text(file_path)
project_text = project_text_from_fields(
uploaded_project_text,
title,
team,
project_status,
study_type_hint,
research_question,
study_design,
participants,
recruitment,
eligibility,
intervention_or_exposure,
comparator,
outcomes,
sample_size,
bias_controls,
ethics_plan,
consent_privacy,
analysis_plan,
missing_data_plan,
transparency_plan,
funding_conflicts,
notes,
)
if not project_text:
return None
display_title = normalize_space(title) or truncate(research_question, 80) or "Untitled research project"
metadata = {
"title": display_title,
"team": normalize_space(team),
"project_status": normalize_space(project_status),
"source": source_name if uploaded_project_text else "User research project form",
}
report = evaluate_study_text(
project_text,
metadata,
scope="research project plan supplied by the user",
forced_study_key=key_for_type_hint(study_type_hint),
)
return {
"title": display_title,
"team": normalize_space(team),
"project_status": normalize_space(project_status),
"study_type": report["study_label"],
"source": metadata["source"],
"created_at": datetime.now(timezone.utc).isoformat(timespec="seconds"),
"text": project_text,
"report": report,
}
def add_project_ui(
file_path: Any,
title: str,
team: str,
project_status: str,
study_type_hint: str,
research_question: str,
study_design: str,
participants: str,
recruitment: str,
eligibility: str,
intervention_or_exposure: str,
comparator: str,
outcomes: str,
sample_size: str,
bias_controls: str,
ethics_plan: str,
consent_privacy: str,
analysis_plan: str,
missing_data_plan: str,
transparency_plan: str,
funding_conflicts: str,
notes: str,
projects: list[dict[str, Any]] | None,
):
project = make_project_record(
file_path,
title,
team,
project_status,
study_type_hint,
research_question,
study_design,
participants,
recruitment,
eligibility,
intervention_or_exposure,
comparator,
outcomes,
sample_size,
bias_controls,
ethics_plan,
consent_privacy,
analysis_plan,
missing_data_plan,
transparency_plan,
funding_conflicts,
notes,
)
if not project:
return (
project_table_rows(projects),
gr.update(choices=project_choices(projects), value=None),
projects or [],
"Add at least a title, research question, or project plan detail.",
*empty_outputs("Add project details first."),
)
updated_projects = [*(projects or []), project]
choices = project_choices(updated_projects)
status = f"Added {project['title']} to this session and reviewed the current plan."
return (
project_table_rows(updated_projects),
gr.update(choices=choices, value=choices[-1]),
updated_projects,
status,
*report_outputs(project["report"]),
)
def review_project_ui(choice: str, projects: list[dict[str, Any]] | None):
projects = projects or []
if not choice or not projects:
return empty_outputs("Add a research project first, then select it for review.")
match = re.match(r"^(\d+)\.", choice)
index = int(match.group(1)) - 1 if match else 0
if index < 0 or index >= len(projects):
return empty_outputs("Selected project was not found in this session.")
return report_outputs(projects[index]["report"])
def download_projects_ui(projects: list[dict[str, Any]] | None):
projects = projects or []
if not projects:
return None
exportable = []
for project in projects:
report = project.get("report", {})
exportable.append(
{
"title": project.get("title"),
"team": project.get("team"),
"project_status": project.get("project_status"),
"study_type": report.get("study_label"),
"created_at": project.get("created_at"),
"overall_score": report.get("overall"),
"risk_level": report.get("level"),
"source": project.get("source"),
"benchmarks": [
{
"benchmark": row[0],
"status": row[1],
"score": row[2],
"required_action": row[5],
}
for row in report.get("benchmarks", [])
],
"key_gaps": top_project_gaps(report, limit=6),
"plan_text": project.get("text"),
}
)
with tempfile.NamedTemporaryFile("w", delete=False, suffix=".json", encoding="utf-8") as handle:
json.dump(exportable, handle, indent=2)
return handle.name
def qwen_project_prompt(project: dict[str, Any], extra_instruction: str) -> str:
report = project.get("report", {})
benchmark_lines = [
f"- {row[0]}: {row[1]} ({row[2]}). Required action: {row[5]}"
for row in report.get("benchmarks", [])
]
checklist_lines = [
f"- {item['criterion']}: {item['status']}. Recommendation: {item['recommendation']}"
for item in report.get("checklist", [])
if item.get("status") != "Reported"
]
return f"""
You are OpenStudy's research benchmark review agent.
Review only the supplied project text and benchmark results. Do not invent approvals, methods, outcomes, or safeguards. Do not certify that the study is ethical or unbiased. Identify concrete protocol improvements a scientist can make before or during the project.
Project title: {project.get('title', 'Untitled project')}
Study type: {report.get('study_label', 'Unknown')}
Overall benchmark screen: {report.get('overall', 0):.1f}/100 - {report.get('level', 'Unknown')}
Benchmarks:
{chr(10).join(benchmark_lines) or '- No benchmark rows available.'}
Open checklist gaps:
{chr(10).join(checklist_lines[:16]) or '- No open checklist gaps flagged.'}
Project text:
{truncate(project.get('text', ''), MAX_QWEN_CONTEXT_CHARS)}
Extra reviewer instruction:
{normalize_space(extra_instruction) or 'None'}
Return Markdown with these sections:
1. Qwen benchmark verdict
2. Highest-priority fixes before continuing
3. Bias and ethics risks to monitor
4. Evidence missing from the project file
5. Suggested next protocol edits
"""
def qwen_agent_review(project: dict[str, Any], hf_token: str, extra_instruction: str) -> str:
token = normalize_space(hf_token) or os.getenv("HF_TOKEN") or os.getenv("HUGGINGFACEHUB_API_TOKEN")
prompt = qwen_project_prompt(project, extra_instruction)
messages = [
{
"role": "system",
"content": (
f"You are a research-methods benchmark reviewer. You must use only {QWEN_MODEL_ID} "
"as the configured model and must not mention or rely on any other model."
),
},
{"role": "user", "content": prompt},
]
try:
client = InferenceClient(model=QWEN_MODEL_ID, token=token or None, timeout=90)
response = client.chat_completion(
messages=messages,
model=QWEN_MODEL_ID,
max_tokens=900,
temperature=0.2,
)
content = response.choices[0].message.content
if not content:
raise RuntimeError("The model returned an empty response.")
return f"### Qwen agent review\n\n**Model used:** `{QWEN_MODEL_ID}`\n\n{content}"
except Exception as exc:
return (
"### Qwen agent review unavailable\n\n"
f"**Required model:** `{QWEN_MODEL_ID}`\n\n"
"OpenStudy did not run another model. Configure a Hugging Face token as a Space secret named `HF_TOKEN`, "
"or paste a temporary token in the project tab, then retry.\n\n"
f"Technical detail: `{truncate(str(exc), 500)}`"
)
def qwen_agent_review_ui(
choice: str,
projects: list[dict[str, Any]] | None,
hf_token: str,
extra_instruction: str,
) -> str:
projects = projects or []
if not projects:
return "### Qwen agent review\n\nAdd or upload a research project first."
if not choice:
index = len(projects) - 1
else:
match = re.match(r"^(\d+)\.", choice)
index = int(match.group(1)) - 1 if match else len(projects) - 1
if index < 0 or index >= len(projects):
return "### Qwen agent review\n\nSelected project was not found in this session."
return qwen_agent_review(projects[index], hf_token, extra_instruction)
def extract_text_from_file(path: str) -> str:
suffix = Path(path).suffix.lower()
try:
if suffix == ".pdf":
reader = PdfReader(path)
pages = []
for page in reader.pages[:80]:
pages.append(page.extract_text() or "")
return normalize_space("\n".join(pages))
if suffix == ".docx":
document = Document(path)
blocks = [paragraph.text for paragraph in document.paragraphs]
for table in document.tables:
for row in table.rows:
blocks.append(" | ".join(cell.text for cell in row.cells))
return normalize_space("\n".join(blocks))
return Path(path).read_text(encoding="utf-8", errors="ignore")
except Exception as exc:
return f"Could not extract file text: {exc}"
def report_outputs(report: dict[str, Any], standards_md: str = ""):
summary = summary_markdown(report)
if standards_md:
summary = f"{summary}\n{standards_md}"
return (
summary,
score_plot(report["scores"], report.get("risk_thresholds", DEFAULT_RISK_THRESHOLDS)),
conduct_markdown(report),
report.get("benchmarks", []),
report["biases"],
checklist_rows(report),
write_report_file(report),
)
def empty_outputs(message: str):
fig, ax = plt.subplots(figsize=(7, 2.5))
style_plot(fig, ax)
ax.text(0.5, 0.5, message, ha="center", va="center", wrap=True, color=INK_SOFT)
ax.axis("off")
return (
f"### {message}",
fig,
"### How the study appears to have been conducted\nNo study has been evaluated yet.",
[],
[],
[],
None,
)
def build_app() -> gr.Blocks:
blocks_kwargs: dict[str, Any] = {"title": f"{APP_NAME}: Check Studies for Bias Controls, Ethics, and Credibility"}
if "head" in inspect.signature(gr.Blocks.__init__).parameters:
blocks_kwargs["head"] = APP_HEAD
launch_params = inspect.signature(gr.Blocks.launch).parameters
if "theme" not in launch_params:
blocks_kwargs["theme"] = THEME
if "css" not in launch_params:
blocks_kwargs["css"] = APP_CSS
with gr.Blocks(**blocks_kwargs) as demo:
gr.HTML(
f"""
<header class="os-hero">
<div class="os-wordmark">{APP_NAME}</div>
<h1>Check research studies for bias controls, ethics, and credibility.</h1>
<p class="os-lede">{APP_NAME} scores how completely a study reports the safeguards that make
research trustworthy: randomization and blinding, ethics approval and consent, funding and
conflict disclosures, data sharing, and limitations. It then judges the study against standards
you set. Look up any published paper by topic, title, or DOI, or add your own study to see
exactly which safeguards are missing before reviewers find them.</p>
<div class="os-badges">
<span class="os-badge os-badge-brand">Rule-based & transparent</span>
<span class="os-badge">Nothing stored after your session</span>
<span class="os-badge">Optional AI review: {QWEN_MODEL_ID}</span>
<span class="os-badge">Open source · MIT</span>
</div>
<div class="os-note"><strong>Decision support, not a verdict.</strong> {APP_NAME} flags what is
reported or missing in the supplied text; it does not certify that a study is ethical, unbiased,
valid, or invalid.</div>
</header>
"""
)
with gr.Row():
cta_lookup = gr.Button("π Look up a paper", variant="primary", elem_classes=["os-cta"])
cta_add = gr.Button("β Add your research study", variant="secondary", elem_classes=["os-cta"])
category_legend = "\n".join(
f"| **{category}** | {explanation} |" for category, explanation in CATEGORY_EXPLANATIONS.items()
)
with gr.Accordion("What the safeguard scores mean", open=False):
gr.Markdown(
f"""
Every paper is checked against a transparent checklist of reporting safeguards. Each safeguard is marked
β
**Reported** (full credit), β οΈ **Potential concern** (quarter credit), or β **Missing or unclear** (no credit).
A category's score is the share of credit earned, from 0 to 100. The score measures **how completely the study
is reported**, not whether its findings are true.
| Score | Default reading |
| --- | --- |
| 75β100 | **Lower reporting risk**: the text reports most safeguards readers expect. |
| 50β74 | **Moderate reporting risk**: several safeguards reported, but important items need review. |
| 0β49 | **Higher reporting risk**: many expected safeguards are missing or unclear. |
You can move these boundaries in *Your screening standards* below.
**What each category checks**
| Category | What it measures |
| --- | --- |
{category_legend}
A low score can also mean the available text was short (for example, only an abstract); it does not by
itself prove poor conduct.
"""
)
with gr.Accordion("Your screening standards (applied when you evaluate or add a paper)", open=False):
gr.Markdown(
"Set the bar a paper must meet. Every evaluation shows a clear verdict against these standards."
)
std_categories = gr.CheckboxGroup(
label="Categories that count toward your score",
choices=STANDARD_CATEGORIES,
value=STANDARD_CATEGORIES,
)
with gr.Row():
std_required = gr.Dropdown(
label="Safeguards that must be reported",
choices=STANDARD_CRITERIA_LABELS,
multiselect=True,
value=[],
scale=3,
)
std_min_score = gr.Slider(0, 100, value=60, step=5, label="Minimum safeguard score", scale=2)
with gr.Row():
std_risk_moderate = gr.Slider(
0, 100, value=DEFAULT_RISK_THRESHOLDS[0], step=5,
label='"Higher risk" below this score',
)
std_risk_lower = gr.Slider(
0, 100, value=DEFAULT_RISK_THRESHOLDS[1], step=5,
label='"Lower risk" at or above this score',
)
std_terms = gr.Textbox(
label="Custom required terms (comma-separated)",
placeholder="Example: preregistration, informed consent, data sharing",
)
standards_inputs = [std_categories, std_required, std_min_score, std_terms, std_risk_moderate, std_risk_lower]
with gr.Tabs() as main_tabs:
with gr.Tab("Look up a paper", id="lookup"):
with gr.Row():
query = gr.Textbox(
label="Find a paper by title, DOI, URL, or keywords",
placeholder="Example: 10.1056/NEJMoa2034577 or paste a paper title, then press Enter",
scale=6,
)
search_button = gr.Button("Search", variant="primary", scale=1, min_width=130)
gr.Examples(
label="Try one of these",
examples=[
["10.1056/NEJMoa2034577"],
["mediterranean diet cardiovascular randomized trial"],
["deep learning chest x-ray diagnosis"],
],
inputs=[query],
)
with gr.Accordion("Search options", open=False):
rows = gr.Slider(
MIN_TOPIC_PAPERS,
MAX_TOPIC_PAPERS,
value=DEFAULT_TOPIC_PAPERS,
step=5,
label=f"Papers per topic (minimum {MIN_TOPIC_PAPERS})",
)
search_status = gr.Markdown()
studies_state = gr.State([])
results_table = gr.Dataframe(
headers=["#", "Title", "Year", "Venue", "DOI", "Source", "Available abstract preview"],
datatype=["number", "str", "str", "str", "str", "str", "str"],
interactive=False,
wrap=True,
elem_classes=["compact-table"],
)
selected = gr.Dropdown(label="Selected result (click a row above, or pick here)", choices=[], interactive=True)
analyze_button = gr.Button("Evaluate selected study", variant="secondary", elem_classes=["os-action"])
with gr.Row():
summary = gr.Markdown()
plot = gr.Plot(label="Category scores", show_label=False)
conduct = gr.Markdown()
benchmarks_table = gr.Dataframe(
headers=["Benchmark", "Status", "Score", "Description", "Evidence", "Required action"],
interactive=False,
wrap=True,
)
bias_table = gr.Dataframe(
headers=["Signal", "Status", "Evidence from available text", "Suggested next check"],
interactive=False,
wrap=True,
)
checklist = gr.Dataframe(
headers=["Category", "Criterion", "Status", "Evidence", "Recommendation"],
interactive=False,
wrap=True,
)
report_file = gr.File(label="Download Markdown report")
search_button.click(
search_studies_ui,
inputs=[query, rows],
outputs=[results_table, selected, studies_state, search_status],
)
query.submit(
search_studies_ui,
inputs=[query, rows],
outputs=[results_table, selected, studies_state, search_status],
)
results_table.select(
select_result_ui,
inputs=[studies_state, *standards_inputs],
outputs=[selected, summary, plot, conduct, benchmarks_table, bias_table, checklist, report_file],
)
analyze_button.click(
analyze_selected_ui,
inputs=[selected, studies_state, *standards_inputs],
outputs=[summary, plot, conduct, benchmarks_table, bias_table, checklist, report_file],
)
with gr.Tab("Add your study", id="add"):
gr.Markdown(
"""
Add your own research study, or any paper, by file or pasted text. OpenStudy screens it for the
bias-control, ethics, transparency, and credibility safeguards it reports, using the standards and
parameters you set above, and tells you exactly what to strengthen.
"""
)
with gr.Row():
upload = gr.File(
label="Upload study PDF, DOCX, TXT, or Markdown",
file_types=[".pdf", ".docx", ".txt", ".md"],
type="filepath",
)
with gr.Column():
upload_title = gr.Textbox(label="Study title (optional)")
type_hint = gr.Dropdown(
label="Study type hint",
choices=STUDY_TYPE_CHOICES,
value="Auto-detect",
)
pasted = gr.Textbox(
label="Paste abstract, methods, or manuscript text (optional)",
lines=10,
placeholder="Paste text here if you do not have a PDF or want to supplement extraction.",
)
upload_button = gr.Button("Add paper and evaluate against my standards", variant="primary", elem_classes=["os-action"])
with gr.Row():
upload_summary = gr.Markdown()
upload_plot = gr.Plot(label="Category scores", show_label=False)
upload_conduct = gr.Markdown()
upload_benchmarks = gr.Dataframe(
headers=["Benchmark", "Status", "Score", "Description", "Evidence", "Required action"],
interactive=False,
wrap=True,
)
upload_bias = gr.Dataframe(
headers=["Signal", "Status", "Evidence from available text", "Suggested next check"],
interactive=False,
wrap=True,
)
upload_checklist = gr.Dataframe(
headers=["Category", "Criterion", "Status", "Evidence", "Recommendation"],
interactive=False,
wrap=True,
)
upload_report_file = gr.File(label="Download Markdown report")
upload_button.click(
analyze_upload_ui,
inputs=[upload, pasted, upload_title, type_hint, *standards_inputs],
outputs=[upload_summary, upload_plot, upload_conduct, upload_benchmarks, upload_bias, upload_checklist, upload_report_file],
)
with gr.Tab("My research projects", id="projects"):
gr.Markdown(
"""
Add a study idea, protocol, or active project to review whether the planned conduct follows the benchmarks readers and reviewers will expect.
Project data is kept in this browser session only. Download the report or portfolio export if you want to keep it.
"""
)
projects_state = gr.State([])
project_file = gr.File(
label="Upload project, protocol, benchmark plan, or preregistration",
file_types=[".pdf", ".docx", ".txt", ".md", ".json", ".csv", ".tsv"],
type="filepath",
)
with gr.Row():
project_title = gr.Textbox(label="Project title", placeholder="Example: Community sleep intervention pilot")
project_team = gr.Textbox(label="Team or owner", placeholder="Lab, PI, student group, or organization")
with gr.Row():
project_status = gr.Dropdown(
label="Project status",
choices=["Idea", "Protocol drafting", "Ethics review", "Recruiting", "Data collection", "Analysis", "Manuscript drafting", "Completed"],
value="Protocol drafting",
)
project_type = gr.Dropdown(label="Study type", choices=STUDY_TYPE_CHOICES, value="Auto-detect")
research_question = gr.Textbox(label="Research question or hypothesis", lines=2)
with gr.Accordion("Design and participants", open=True):
study_design = gr.Textbox(label="Study design", lines=2, placeholder="Design, setting, timeline, and whether it is prospective, retrospective, randomized, observational, qualitative, etc.")
participants = gr.Textbox(label="Population or sample", lines=2, placeholder="Who or what will be studied, expected sample, and important demographics.")
recruitment = gr.Textbox(label="Recruitment source and study period", lines=2, placeholder="Where participants/data come from, how they are approached, and when data will be collected.")
eligibility = gr.Textbox(label="Inclusion and exclusion criteria", lines=2)
with gr.Accordion("Measures and bias controls", open=True):
intervention_or_exposure = gr.Textbox(label="Intervention, exposure, or focus", lines=2)
comparator = gr.Textbox(label="Comparator or control", lines=2, placeholder="Placebo, usual care, matched controls, pre/post comparison, or why none is appropriate.")
outcomes = gr.Textbox(label="Primary and secondary outcomes", lines=2, placeholder="Name primary outcomes before data collection when possible.")
sample_size = gr.Textbox(label="Sample size or power rationale", lines=2)
bias_controls = gr.Textbox(label="Bias controls", lines=3, placeholder="Randomization, blinding, allocation concealment, validated measures, training, calibration, reflexivity, or confounder controls.")
with gr.Accordion("Ethics, analysis, and transparency", open=True):
ethics_plan = gr.Textbox(label="Ethics approval and oversight", lines=2, placeholder="IRB/ethics committee, exemption rationale, animal-care approval, or oversight plan.")
consent_privacy = gr.Textbox(label="Consent, privacy, and safety safeguards", lines=2)
analysis_plan = gr.Textbox(label="Statistical or qualitative analysis plan", lines=3)
missing_data_plan = gr.Textbox(label="Missing data, attrition, or follow-up plan", lines=2)
transparency_plan = gr.Textbox(label="Data, code, materials, and preregistration plan", lines=2)
funding_conflicts = gr.Textbox(label="Funding, sponsor role, and conflicts of interest", lines=2)
project_notes = gr.Textbox(label="Additional notes", lines=2)
add_project_button = gr.Button("Add project and review plan", variant="primary", elem_classes=["os-action"])
project_status_text = gr.Markdown()
project_table = gr.Dataframe(
headers=["#", "Project", "Detected/review type", "Status", "Score", "Risk level", "Key gaps"],
datatype=["number", "str", "str", "str", "str", "str", "str"],
interactive=False,
wrap=True,
)
with gr.Row():
project_select = gr.Dropdown(label="Select a saved project from this session", choices=[], interactive=True)
review_project_button = gr.Button("Review selected project", variant="secondary")
export_projects_button = gr.Button("Download project portfolio JSON")
projects_file = gr.File(label="Project portfolio export")
with gr.Accordion(f"Qwen agent benchmark review ({QWEN_MODEL_ID} only)", open=False):
gr.Markdown(
f"""
The AI reviewer is constrained to `{QWEN_MODEL_ID}`. OpenStudy will not fall back to another model.
For Hugging Face Spaces, set a secret named `HF_TOKEN`, or paste a temporary Hugging Face token below for this session.
"""
)
qwen_token = gr.Textbox(label="Hugging Face token (optional)", type="password")
qwen_instruction = gr.Textbox(
label="Extra Qwen review focus (optional)",
lines=2,
placeholder="Example: Focus on recruitment fairness and IRB readiness.",
)
qwen_button = gr.Button("Run Qwen benchmark agent", variant="secondary", elem_classes=["os-action"])
qwen_output = gr.Markdown()
with gr.Row():
project_summary = gr.Markdown()
project_plot = gr.Plot(label="Category scores", show_label=False)
project_conduct = gr.Markdown()
project_benchmarks = gr.Dataframe(
headers=["Benchmark", "Status", "Score", "Description", "Evidence", "Required action"],
interactive=False,
wrap=True,
)
project_bias = gr.Dataframe(
headers=["Signal", "Status", "Evidence from project plan", "Suggested next check"],
interactive=False,
wrap=True,
)
project_checklist = gr.Dataframe(
headers=["Category", "Criterion", "Status", "Evidence", "Recommendation"],
interactive=False,
wrap=True,
)
project_report_file = gr.File(label="Download project review report")
project_inputs = [
project_file,
project_title,
project_team,
project_status,
project_type,
research_question,
study_design,
participants,
recruitment,
eligibility,
intervention_or_exposure,
comparator,
outcomes,
sample_size,
bias_controls,
ethics_plan,
consent_privacy,
analysis_plan,
missing_data_plan,
transparency_plan,
funding_conflicts,
project_notes,
projects_state,
]
add_project_button.click(
add_project_ui,
inputs=project_inputs,
outputs=[
project_table,
project_select,
projects_state,
project_status_text,
project_summary,
project_plot,
project_conduct,
project_benchmarks,
project_bias,
project_checklist,
project_report_file,
],
)
review_project_button.click(
review_project_ui,
inputs=[project_select, projects_state],
outputs=[project_summary, project_plot, project_conduct, project_benchmarks, project_bias, project_checklist, project_report_file],
)
export_projects_button.click(download_projects_ui, inputs=[projects_state], outputs=[projects_file])
qwen_button.click(
qwen_agent_review_ui,
inputs=[project_select, projects_state, qwen_token, qwen_instruction],
outputs=[qwen_output],
)
with gr.Tab("Method", id="method"):
gr.Markdown(
"""
## How the screen works
OpenStudy uses rule-based, transparent benchmark checks inspired by common reporting safeguards across trials, observational studies, reviews, qualitative research, animal studies, and model studies.
The score is a **reported-or-planned safeguard score**, not a truth score. A low score can mean the study is poorly reported, the public abstract is too short, the uploaded text did not include the methods, ethics, funding, and limitations sections, or a project plan still needs those safeguards added.
The optional AI review uses **`Qwen/Qwen3.6-27B` only** through Hugging Face inference. If that model is not available with the configured token/provider, OpenStudy does not switch to another model.
Recommended human follow-up:
- Read the full methods, supplement, protocol, registry entry, and conflict-of-interest statements.
- Compare outcomes in the manuscript with the protocol or registration.
- Ask domain experts to judge whether the design and analysis fit the research question.
- Treat ethics and participant-protection findings as prompts for review, not legal or IRB determinations.
- For unpublished projects, use the project report as a protocol-improvement checklist before recruitment or data collection.
- Upload protocol, benchmark, or preregistration files in the project tab to check whether planned safeguards are present.
"""
)
cta_lookup.click(lambda: gr.Tabs(selected="lookup"), outputs=[main_tabs])
cta_add.click(lambda: gr.Tabs(selected="add"), outputs=[main_tabs])
gr.HTML(
f"""
<footer class="os-footer">
<span>{APP_NAME} · open-source study screening · MIT license</span>
<span>A reported-safeguard screen, not a verdict on validity or ethics.</span>
</footer>
"""
)
return demo
demo = build_app()
def launch_app() -> None:
launch_kwargs: dict[str, Any] = {}
launch_params = inspect.signature(demo.launch).parameters
if "theme" in launch_params:
launch_kwargs["theme"] = THEME
if "css" in launch_params:
launch_kwargs["css"] = APP_CSS
demo.launch(**launch_kwargs)
if __name__ == "__main__":
launch_app()
|