-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
39 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters