Skip to content

Commit

Permalink
add zenodo link, fix typo
Browse files Browse the repository at this point in the history
  • Loading branch information
slowkow committed May 3, 2024
1 parent 09b9aad commit c3f933d
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 8 deletions.
7 changes: 5 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ output:
# hlabud <img width="25%" align="right" src="https://github.com/slowkow/hlabud/assets/209714/b39a3f04-c9a8-4867-a3e0-9434f0f9ef20"></img>

[![R-CMD-check](https://github.com/slowkow/hlabud/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/slowkow/hlabud/actions/workflows/R-CMD-check.yaml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11093557.svg)](https://doi.org/10.5281/zenodo.11093557)

hlabud provides methods to retrieve sequence alignment data from [IMGTHLA] and convert the data into convenient R matrices ready for downstream analysis. See the [usage examples](https://slowkow.github.io/hlabud/articles/examples.html) to learn how to use the data with logistic regression and dimensionality reduction. We also share tips on how to [visualize the 3D molecular structure](https://slowkow.github.io/hlabud/articles/visualize-hla-structure.html) of HLA proteins and highlight specific amino acid residues.

Expand Down Expand Up @@ -90,7 +91,7 @@ See the [usage examples](https://slowkow.github.io/hlabud/articles/examples.html

Additionally, you can also cite the `hlabud` package like this:

- Slowikowski K. hlabud: methods for access and analysis of the human leukocyte antigen (HLA) gene sequence alignments from IMGT/HLA. R package version 1.0.0.
- Slowikowski K. hlabud: HLA analysis in R. Zenodo. https://doi.org/10.5281/zenodo.11093557

# Related work

Expand All @@ -116,5 +117,7 @@ CRAN. Here is the related article:

- Pappas DJ, Marin W, Hollenbach JA, Mack SJ. [Bridging ImmunoGenomic Data Analysis Workflow Gaps (BIGDAWG): An integrated case-control analysis pipeline.](https://pubmed.ncbi.nlm.nih.gov/26708359) Hum Immunol. 2016;77: 283–287.

[HLAdivR] is another R package for calculating HLA divergence.

[HLAdivR]: https://github.com/rbentham/HLAdivR/

https://github.com/rbentham/HLAdivR/
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# hlabud <img width="25%" align="right" src="https://github.com/slowkow/hlabud/assets/209714/b39a3f04-c9a8-4867-a3e0-9434f0f9ef20"></img>

[![R-CMD-check](https://github.com/slowkow/hlabud/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/slowkow/hlabud/actions/workflows/R-CMD-check.yaml)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.11093557.svg)](https://doi.org/10.5281/zenodo.11093557)

hlabud provides methods to retrieve sequence alignment data from
[IMGTHLA](https://github.com/ANHIG/IMGTHLA) and convert the data into
Expand Down Expand Up @@ -120,9 +121,8 @@ please cite the AFND paper:

Additionally, you can also cite the `hlabud` package like this:

- Slowikowski K. hlabud: methods for access and analysis of the human
leukocyte antigen (HLA) gene sequence alignments from IMGT/HLA. R
package version 1.0.0.
- Slowikowski K. hlabud: HLA analysis in R. Zenodo.
<https://doi.org/10.5281/zenodo.11093557>

# Related work

Expand Down Expand Up @@ -157,4 +157,5 @@ available on CRAN. Here is the related article:
analysis pipeline.](https://pubmed.ncbi.nlm.nih.gov/26708359) Hum
Immunol. 2016;77: 283–287.

<https://github.com/rbentham/HLAdivR/>
[HLAdivR](https://github.com/rbentham/HLAdivR/) is another R package for
calculating HLA divergence.
2 changes: 1 addition & 1 deletion index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ dosage(a$onehot, c("DRB1*03:01:05", "DRB1*03:02:03"))
```

From this output, we can conclude that four positions (26, 28, 47, 86) distinguish these two HLA-DRB1 alleles.
We see that DRB1\*03:01:05 has a F at position 26 and DRB1\*03:02:03 has a Y.
We see that DRB1\*03:01:05 has a Y at position 26 and DRB1\*03:02:03 has a F.


Installation
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ What amino acid positions are different between these two genotypes?

From this output, we can conclude that four positions (26, 28, 47, 86)
distinguish these two HLA-DRB1 alleles. We see that DRB1\*03:01:05 has a
F at position 26 and DRB1\*03:02:03 has a Y.
Y at position 26 and DRB1\*03:02:03 has a F.

# Installation

Expand Down
Binary file modified vignettes/articles/examples_files/figure-html/umap-2digit-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vignettes/articles/examples_files/figure-html/umap-57-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vignettes/articles/examples_files/figure-html/umap-D57-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c3f933d

Please sign in to comment.