Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Platform] Add QC warnings to study page #588

Merged
merged 5 commits into from
Dec 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 59 additions & 90 deletions apps/platform/src/pages/CredibleSetPage/ProfileHeader.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Fragment, useState } from "react";
import { Fragment } from "react";
import {
usePlatformApi,
Field,
Expand All @@ -9,14 +9,13 @@ import {
PublicationsDrawer,
ClinvarStars,
LabelChip,
DetailPopover,
} from "ui";
import { Box, Typography, Popover } from "@mui/material";
import { Box, Typography } from "@mui/material";
import CREDIBLE_SET_PROFILE_HEADER_FRAGMENT from "./ProfileHeader.gql";
import { getStudyCategory } from "sections/src/utils/getStudyCategory";
import { epmcUrl } from "../../utils/urls";
import { credsetConfidenceMap, poulationMap } from "../../constants";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faCaretDown, faTriangleExclamation } from "@fortawesome/free-solid-svg-icons";
import { v1 } from "uuid";

type ProfileHeaderProps = {
Expand Down Expand Up @@ -44,72 +43,34 @@ const dicSummary = [
},
];

function SummaryStatisticsField({ sumstatQCValues }: any) {
const [anchorEl, setAnchorEl] = useState<HTMLButtonElement | null>(null);
if (!sumstatQCValues) return null;

const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {
setAnchorEl(event.currentTarget);
};

const handleClose = () => {
setAnchorEl(null);
};

const open = Boolean(anchorEl);
const id = open ? "simple-popover" : undefined;

function SummaryStatsTable({ sumstatQCValues }: any) {
return (
<Fragment>
<Typography
sx={{ cursor: "pointer", mr: 0.5, fontWeight: 600, color: "secondary.main" }}
aria-describedby={id}
variant="contained"
onClick={handleClick}
>
Available <FontAwesomeIcon icon={faCaretDown} />
<>
<Typography sx={{ fontSize: 16, fontWeight: 600, my: 1 }} variant="subtitle2">
Harmonised summary statistics
</Typography>

<Popover
id={id}
open={open}
anchorEl={anchorEl}
onClose={handleClose}
elevation={1}
disableScrollLock
anchorOrigin={{
vertical: "bottom",
horizontal: "left",
}}
>
<Box sx={{ p: 2 }}>
<Typography sx={{ fontSize: 16, fontWeight: 600, my: 1 }} variant="subtitle2">
Harmonised summary statistics
</Typography>
<table>
<tbody>
{dicSummary.map((sumstat: any) => {
const summStatValue = sumstatQCValues.find(
(v: any) => v.QCCheckName === sumstat.id
).QCCheckValue;
return (
<tr key={v1()}>
<td>
<Tooltip title={sumstat.tooltip} showHelpIcon>
{sumstat.label}
</Tooltip>
</td>
<Typography sx={{ textAlign: "right" }} component="td" variant="body2">
{summStatValue}
</Typography>
</tr>
);
})}
</tbody>
</table>
</Box>
</Popover>
</Fragment>
<table>
<tbody>
{dicSummary.map((sumstat: any) => {
const summStatValue = sumstatQCValues.find(
(v: any) => v.QCCheckName === sumstat.id
).QCCheckValue;
return (
<tr key={v1()}>
<td>
<Tooltip title={sumstat.tooltip} showHelpIcon>
{sumstat.label}
</Tooltip>
</td>
<Typography sx={{ textAlign: "right" }} component="td" variant="body2">
{summStatValue}
</Typography>
</tr>
);
})}
</tbody>
</table>
</>
);
}

Expand All @@ -128,7 +89,7 @@ function ProfileHeader({ variantId }: ProfileHeaderProps) {
const standardError = leadVariant?.standardError ?? credibleSet?.standardError;
const { pValueMantissa, pValueExponent } =
typeof leadVariant?.pValueMantissa === "number" &&
typeof leadVariant?.pValueExponent === "number"
typeof leadVariant?.pValueExponent === "number"
? leadVariant
: credibleSet ?? {};

Expand Down Expand Up @@ -265,7 +226,24 @@ function ProfileHeader({ variantId }: ProfileHeaderProps) {
>
{credibleSet?.purityMinR2?.toPrecision(3)}
</Field>
</Box>
{credibleSet?.qualityControls?.length > 0 &&
<Box>
<DetailPopover title="QC warnings">
<ul style={{
display: "flex",
flexDirection: "column",
gap: "0.25rem",
padding: 0,
margin: "0 0 0 1rem"
}}>
{credibleSet.qualityControls.map(warning => (
<li key={warning}>{warning}</li>
))}
</ul>
</DetailPopover>
</Box>
}
</Box >

<Box>
<Typography variant="subtitle1" mt={0}>
Expand Down Expand Up @@ -342,14 +320,16 @@ function ProfileHeader({ variantId }: ProfileHeaderProps) {
{study?.analysisFlags ? study.analysisFlags : "Not Available"}
</Field>
)}
{study?.hasSumstats && (
<Field loading={loading} title="Summary statistics">
<SummaryStatisticsField
hasSumstats={study?.hasSumstats}
sumstatQCValues={study?.sumstatQCValues}
/>
</Field>
)}
<Field loading={loading} title="Summary statistics">
{!study?.hasSumstats
? "Not Available"
: study?.sumstatQCValues
? <DetailPopover title="Available">
<SummaryStatsTable sumstatQCValues={study.sumstatQCValues} />
</DetailPopover>
: "Available"
}
</Field>
<Field loading={loading} title="Sample size">
{study?.nSamples.toLocaleString()}
</Field>
Expand All @@ -364,20 +344,9 @@ function ProfileHeader({ variantId }: ProfileHeaderProps) {
tooltip={`LD reference population: ${poulationMap[ldPopulation]}`}
/>
))}
{/* Quality controls */}
{study?.qualityControls?.length > 0 && (
<Tooltip title={study?.qualityControls.join(", ")} arrow>
<LabelChip
label={<FontAwesomeIcon size="1x" icon={faTriangleExclamation} />}
value={study?.qualityControls.length + " issue"}
tooltip={study?.qualityControls.join("; ")}
color="orange"
/>
</Tooltip>
)}
</Box>
</Box>
</BaseProfileHeader>
</BaseProfileHeader >
);
}

Expand Down
67 changes: 67 additions & 0 deletions packages/ui/src/components/DetailPopover.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import { ReactNode, useState } from "react";
import { Typography, Popover, Box } from "@mui/material";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import { faCaretDown, faCaretRight } from "@fortawesome/free-solid-svg-icons";

type DetailPopoverProps = {
title: string;
children: ReactNode;
popoverId?: string;
};

export default function DetailPopover({
title,
children,
popoverId = "simple-popover",
}: DetailPopoverProps) {

const [anchorEl, setAnchorEl] = useState<HTMLButtonElement | null>(null);

const handleClick = (event: React.MouseEvent<HTMLButtonElement>) => {
setAnchorEl(event.currentTarget);
};

const handleClose = () => {
setAnchorEl(null);
};

const open = Boolean(anchorEl);
const id = open ? popoverId : undefined;

return (
<>
<Typography
variant="subtitle2"
component="span"
sx={{
display: "inline",
cursor: "pointer",
mr: 0.5,
fontWeight: 600,
color: "secondary.main"
}}
aria-describedby={id}
onClick={handleClick}
>
{title}
{" "}
<FontAwesomeIcon icon={open ? faCaretDown : faCaretRight} />
</Typography>
<Popover
id={id}
open={open}
anchorEl={anchorEl}
onClose={handleClose}
elevation={1}
disableScrollLock
transitionDuration={0}
anchorOrigin={{
vertical: "bottom",
horizontal: "left",
}}
>
<Box p={2}>{children}</Box>
</Popover>
</>
);
}
1 change: 1 addition & 0 deletions packages/ui/src/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ export { default as PrivateRoute } from "./components/PrivateRoute";
export { default as EllsWrapper } from "./components/EllsWrapper";
export { default as ErrorBoundary } from "./components/ErrorBoundary";
export { default as GlobalSearch } from "./components/GlobalSearch/GlobalSearch";
export { default as DetailPopover } from "./components/DetailPopover";

export { default as PrivateWrapper } from "./components/PrivateWrapper";
export { default as NavBar } from "./components/NavBar";
Expand Down
Loading