Skip to content

Commit

Permalink
placeholder help and about
Browse files Browse the repository at this point in the history
  • Loading branch information
ssnn-airr committed May 13, 2024
1 parent 4072df4 commit 6a52015
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 3 deletions.
1 change: 1 addition & 0 deletions inst/shiny-app/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[Software Working Group](https://www.antibodysociety.org/the-airr-community/airr-working-groups/software/)
25 changes: 25 additions & 0 deletions inst/shiny-app/help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
Good analysis requires good data, but how can how can a high-quality
AIRR dataset be distinguished from a low-quality one? Rep-Cred fills this need
by identifying and reporting several key metrics that can be
indicators of potential problems. Modeled after fastqc, Rep-Cred provides an
easily digestible summary that can be used by novices and experts alike.

The only requirement to run Rep-Cred is a file describing IG and/or TCR
rearrangements in the [AIRR TSV format](https://docs.airr-community.org/en/stable/datarep/rearrangements.html).
By default, all repertoires are randomly down-sampled to XXX rearrangements;
we find that this still provides an accurate assessment of repertoire
credibility while maintaining a reasonable run time. Finally, if a custom
(non-IMGT?) database was used to annotate the rearrangements, this should be
provided to Rep-Cred as well, so that SHM and related statistics can be
calculated accurately.

[Example repertoire](https://raw.githubusercontent.com/airr-community/rep-cred/master/inst/extdata/ExampleDb.tsv)

To get help or report a bug, please file an issue on Rep-Cred’s github
page at [https://github.com/airr-community/rep-cred/issues](https://github.com/airr-community/rep-cred/issues).
Although Rep-Cred will not be under active development once the initial release is complete, the program is designed to be modular and accept new functions/metrics with ease. We welcome pull requests
(please see [https://github.com/airr-community/airr-standards/blob/master/CONTRIBUTING.rst](https://github.com/airr-community/airr-standards/blob/master/CONTRIBUTING.rst));
all other feature requests will be evaluated and prioritized with respect to our
availability to work on adding them.


14 changes: 12 additions & 2 deletions inst/shiny-app/ui.R
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,14 @@ ui <- fluidPage(
# App title
fluidRow(
id="div-main",
style = "width:80%; min-width:500px; height:250px",
tags$img(src = "logo.svg", width = "100px"),
tags$h1("Rep-Cred"),
tags$strong("Credibility of a repertoire"),
tags$p("Summary statistics and graphical information to quickly asses the quality of a repertoire."),
tabsetPanel(
tabPanel("Rep-Cred",
style = "width:100%",
br(),
# Input
fileInput("file1",
Expand Down Expand Up @@ -60,8 +62,16 @@ ui <- fluidPage(
uiOutput("openResultsBtn")

),
tabPanel("Help"),
tabPanel("About")
tabPanel("Help",
style = "width:100%",
br(),
includeMarkdown("help.md")
),
tabPanel("About",
style = "width:100%",
br(),
includeMarkdown("about.md")
)
)
)
)
2 changes: 1 addition & 1 deletion inst/shiny-app/www/repcred.css
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
margin: 0;
// position: fixed;
position: absolute;
top: calc(50%);
top: calc(20%);
left: calc(50%);
-ms-transform: translate(-50%, -50%);
transform: translate(-50%, -50%);
Expand Down

0 comments on commit 6a52015

Please sign in to comment.