From c20670f033d0b41f42ac14eeeadcc933475a7966 Mon Sep 17 00:00:00 2001 From: Ulthran Date: Fri, 21 Jun 2024 14:00:44 -0400 Subject: [PATCH] Move mirixdb import to mirix function doc --- .Rbuildignore | 1 + R/abx_index.R | 1 + R/mirix-package.R | 7 ------- man/mirix-package.Rd | 11 ----------- 4 files changed, 2 insertions(+), 18 deletions(-) delete mode 100644 R/mirix-package.R delete mode 100644 man/mirix-package.Rd diff --git a/.Rbuildignore b/.Rbuildignore index 7fcf037..497df46 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,4 @@ ^data-raw$ ^R/abx_index_old\.R$ ^\.github$ +^.*\.Rproj$ diff --git a/R/abx_index.R b/R/abx_index.R index 5c6aacb..d60c766 100644 --- a/R/abx_index.R +++ b/R/abx_index.R @@ -111,6 +111,7 @@ mirix_gentamicin <- function(abundance, #' 0.5 is typical. For relative abundances, a number that is slightly lower #' than the lowest relative abundance will work. #' +#' @import mirixdb #' @return The MiRIx value #' @export mirix <- function (abundance, susceptibility, replace_zero = 1e-4) { diff --git a/R/mirix-package.R b/R/mirix-package.R deleted file mode 100644 index b7762dd..0000000 --- a/R/mirix-package.R +++ /dev/null @@ -1,7 +0,0 @@ -#' @keywords internal -"_PACKAGE" - -## usethis namespace: start -#' @import mirixdb -## usethis namespace: end -NULL diff --git a/man/mirix-package.Rd b/man/mirix-package.Rd deleted file mode 100644 index c71f909..0000000 --- a/man/mirix-package.Rd +++ /dev/null @@ -1,11 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/mirix-package.R -\docType{package} -\name{mirix-package} -\alias{mirix} -\alias{mirix-package} -\title{mirix: Modeling the Susceptibility of a Bacterial Community to Antibiotics} -\description{ -Calculates an index for a given bacterial community's susceptibility to specified antibiotics. -} -\keyword{internal}