richelbilderbeek / mhcnuggetsr

Package to call MHCnuggets from R, to predict MHC-I and MHC-II epitopes

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

mhcnuggetsr

Lifecycle: stable CRAN status

Branch GitHub Actions Codecov logo
master R-CMD-check codecov.io
develop R-CMD-check codecov.io

mhcnuggetsr is broken, see here, as the import of the MHCnuggets Python package by `reticulate`` fails. If you know how to fix this, please contact me

R package to work with MHCnuggets.

The goal of mhcnuggetsr is to predict the half maximal inhibitory concentration of peptides for an MHC haplotype. It does by calling MHCnuggets.

Installation

You can install the released version of mhcnuggetsr from GitHub with:

remotes::install_github("richelbilderbeek/mhcnuggetsr")

Install MHCnuggets using the non-CRAN extension mhcnuggetsrinstall:

# {r install}
library(mhcnuggetsr)

if (!is_mhcnuggets_installed()) {
  remotes::install_github("richelbilderbeek/mhcnuggetsrinstall")
  mhcnuggetsrinstall::install_mhcnuggets()
  mhcnuggetsr_self_test()
}

Example

Here is how to get the IC50 values (in nM) for the peptides in an example file:

# {r example}
library(testthat)
library(mhcnuggetsr)

if (is_mhcnuggets_installed()) {
  mhcnuggets_options <- create_mhcnuggets_options(
    mhc = "HLA-A02:01"
  )
  
  df <- predict_ic50(
    peptides = "AIAACAMLLV",
    mhcnuggets_options = mhcnuggets_options
  )
  expect_equal(df$ic50, 5578.77)
}

How can I suppress the output when making a prediction?

One cannot until MHCnuggets allows to do so. Issue is posted here.

There is a feature I miss

See CONTRIBUTING, at Submitting use cases

I want to collaborate

See CONTRIBUTING, at ‘Submitting code’

I think I have found a bug

See CONTRIBUTING, at ‘Submitting bugs’

There’s something else I want to say

Sure, just add an Issue. Or send an email.

External links

References

Article about MHCnuggets:

  • Shao, Xiaoshan M., et al. “High-throughput prediction of MHC class I and II neoantigens with MHCnuggets.” Cancer Immunology Research 8.3 (2020): 396-408.

About

Package to call MHCnuggets from R, to predict MHC-I and MHC-II epitopes

License:GNU General Public License v3.0


Languages

Language:R 96.2%Language:Singularity 2.1%Language:Shell 1.7%