Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: amR
Title: amR, an R package suite to predict AMR in bacterial pathogens (amRdata, amRml, amRshiny)
Title: amR, an R package suite to predict AMR in bacterial pathogens (amRdata, amRml, amRviz)
Version: 0.0.0.9000
Authors@R: c(
person("Janani", "Ravi", , "janani.ravi@cuanschutz.edu", role = c("aut", "cre"),
Expand All @@ -12,7 +12,7 @@ Authors@R: c(
person("Raymond", "Lesiyon", , "raymond.lesiyon@cuanschutz.edu", role = "ctb"),
person("David", "Mayer", , "david.mayer@cuanschutz.edu", role = "ctb")
)
Description: amR is a metapackage aka package suite that lets users install the 3 packages, amRdata, amRml, and amRshiny with a single install function.
Description: amR is a metapackage aka package suite that lets users install the 3 packages, amRdata, amRml, and amRviz with a single install function.
License: BSD_3_clause + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE)
Expand Down
10 changes: 5 additions & 5 deletions R/install_amR.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#' Install amR package suite
#'
#' Installs all packages in the amR suite for antimicrobial resistance
#' prediction: amRdata, amRml, and amRshiny.
#' prediction: amRdata, amRml, and amRviz.
#'
#' @param packages Character vector specifying which packages to install.
#' Options are "data", "ml", and "shiny". Default installs all three.
#' Options are "data", "ml", and "viz". Default installs all three.
#' @param force Logical. If TRUE, forces reinstallation even if packages
#' are already installed. Default is FALSE.
#' @param upgrade Character. Controls whether to upgrade dependencies.
Expand All @@ -31,13 +31,13 @@
#' # Install specific packages quietly
#' installAMR(packages = c("data", "ml"), quiet = TRUE)
#' }
installAMR <- function(packages = c("data", "ml", "shiny"),
installAMR <- function(packages = c("data", "ml", "viz"),

Check warning on line 34 in R/install_amR.R

View workflow job for this annotation

GitHub Actions / lint

file=R/install_amR.R,line=34,col=1,[object_name_linter] Variable and function name style should match snake_case or symbols.
force = FALSE,
upgrade = "default",
quiet = FALSE) {
# Validate packages argument

valid_packages <- c("data", "ml", "shiny")
valid_packages <- c("data", "ml", "viz")
packages <- match.arg(packages, valid_packages, several.ok = TRUE)


Expand All @@ -46,7 +46,7 @@
repo_map <- c(
data = "JRaviLab/amRdata",
ml = "JRaviLab/amRml",
shiny = "JRaviLab/amRshiny"
viz = "JRaviLab/amRviz"
)

# Install each requested package
Expand Down
12 changes: 6 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The amR suite consists of three packages that work together:
|---------|-------------|------------|
| **amRdata** | Data curation and feature extraction from bacterial genomes | [JRaviLab/amRdata](https://github.com/JRaviLab/amRdata) |
| **amRml** | Machine learning models for AMR prediction | [JRaviLab/amRml](https://github.com/JRaviLab/amRml) |
| **amRshiny** | Interactive dashboard for exploring results | [JRaviLab/amRshiny](https://github.com/JRaviLab/amRshiny) |
| **amRviz** | Interactive dashboard for exploring results | [JRaviLab/amRviz](https://github.com/JRaviLab/amRviz) |

## Installation

Expand All @@ -58,7 +58,7 @@ You can also install packages individually:
```r
remotes::install_github("JRaviLab/amRdata")
remotes::install_github("JRaviLab/amRml")
remotes::install_github("JRaviLab/amRshiny")
remotes::install_github("JRaviLab/amRviz")
```

## Quick start
Expand All @@ -67,23 +67,23 @@ remotes::install_github("JRaviLab/amRshiny")
# Load all packages
library(amRdata)
library(amRml)
library(amRshiny)
library(amRviz)

# 1. Prepare data with amRdata
# features <- prepareFeatures(...)

# 2. Train ML models with amRml
# results <- runMLPipeline(...)

# 3. Explore results with amRshiny
# 3. Explore results with amRviz
# launchDashboard(...)
```

## Workflow overview

```
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ amRdata │ --> │ amRml │ --> │ amRshiny
│ amRdata │ --> │ amRml │ --> │ amRviz
│ │ │ │ │ │
│ - Genomes │ │ - Train LR │ │ - Dashboard │
│ - Features │ │ - Evaluate │ │ - Plots │
Expand All @@ -95,7 +95,7 @@ library(amRshiny)

- [amRdata documentation](https://jravilab.github.io/amRdata)
- [amRml documentation](https://jravilab.github.io/amRml)
- [amRshiny documentation](https://jravilab.github.io/amRshiny)
- [amRviz documentation](https://jravilab.github.io/amRviz)

## Citation

Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
the amR suite of packages for antimicrobial resistance (AMR) prediction
in bacterial pathogens.

<img src="man/figures/README-amR.png" width="60%" style="display: block; margin: auto;" />
<img src="man/figures/README-amR.png" alt="" width="60%" style="display: block; margin: auto;" />

## The amR suite

Expand All @@ -23,7 +23,7 @@ The amR suite consists of three packages that work together:
|----|----|----|
| **amRdata** | Data curation and feature extraction from bacterial genomes | [JRaviLab/amRdata](https://github.com/JRaviLab/amRdata) |
| **amRml** | Machine learning models for AMR prediction | [JRaviLab/amRml](https://github.com/JRaviLab/amRml) |
| **amRshiny** | Interactive dashboard for exploring results | [JRaviLab/amRshiny](https://github.com/JRaviLab/amRshiny) |
| **amRviz** | Interactive dashboard for exploring results | [JRaviLab/amRviz](https://github.com/JRaviLab/amRviz) |

## Installation

Expand All @@ -48,7 +48,7 @@ You can also install packages individually:
``` r
remotes::install_github("JRaviLab/amRdata")
remotes::install_github("JRaviLab/amRml")
remotes::install_github("JRaviLab/amRshiny")
remotes::install_github("JRaviLab/amRviz")
```

## Quick start
Expand All @@ -57,22 +57,22 @@ remotes::install_github("JRaviLab/amRshiny")
# Load all packages
library(amRdata)
library(amRml)
library(amRshiny)
library(amRviz)

# 1. Prepare data with amRdata
# features <- prepareFeatures(...)

# 2. Train ML models with amRml
# results <- runMLPipeline(...)

# 3. Explore results with amRshiny
# 3. Explore results with amRviz
# launchDashboard(...)
```

## Workflow overview

┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ amRdata │ --> │ amRml │ --> │ amRshiny
│ amRdata │ --> │ amRml │ --> │ amRviz
│ │ │ │ │ │
│ - Genomes │ │ - Train LR │ │ - Dashboard │
│ - Features │ │ - Evaluate │ │ - Plots │
Expand All @@ -83,7 +83,7 @@ library(amRshiny)

- [amRdata documentation](https://jravilab.github.io/amRdata)
- [amRml documentation](https://jravilab.github.io/amRml)
- [amRshiny documentation](https://jravilab.github.io/amRshiny)
- [amRviz documentation](https://jravilab.github.io/amRviz)

## Citation

Expand Down
1 change: 1 addition & 0 deletions amR.Rproj
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
Version: 1.0
ProjectId: 6761cf5b-842c-4498-aaa3-1f6bf1b396a4

RestoreWorkspace: No
SaveWorkspace: No
Expand Down
Binary file modified man/figures/README-amR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions man/installAMR.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions tests/testthat/test-install.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@ test_that("installAMR validates package arguments", {
# Valid packages should not error

expect_no_error(
match.arg(c("data", "ml"), c("data", "ml", "shiny"), several.ok = TRUE)
match.arg(c("data", "ml"), c("data", "ml", "viz"), several.ok = TRUE)
)

# Invalid package should error

expect_error(
match.arg("invalid", c("data", "ml", "shiny"), several.ok = TRUE)
match.arg("invalid", c("data", "ml", "viz"), several.ok = TRUE)
)
})

Expand All @@ -28,7 +28,7 @@ test_that("installAMR has correct default arguments", {
args <- formals(installAMR)

# Check default values
expect_equal(eval(args$packages), c("data", "ml", "shiny"))
expect_equal(eval(args$packages), c("data", "ml", "viz"))
expect_false(eval(args$force))
expect_equal(eval(args$upgrade), "default")
expect_false(eval(args$quiet))
Expand Down
6 changes: 3 additions & 3 deletions vignettes/intro.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The amR package suite provides tools for antimicrobial resistance (AMR) predicti

- **amRdata**: Data curation and feature extraction from bacterial genomes
- **amRml**: Machine learning models for AMR prediction
- **amRshiny**: Interactive dashboard for exploring results
- **amRviz**: Interactive dashboard for exploring results

## Installation

Expand All @@ -30,7 +30,7 @@ library(amR)
installAMR()
```

This will install amRdata, amRml, and amRshiny from GitHub.
This will install amRdata, amRml, and amRviz from GitHub.

### Installing specific packages

Expand Down Expand Up @@ -64,6 +64,6 @@ installAMR(upgrade = "never")
A typical amR workflow involves:
1. Preparing genomic feature data with **amRdata**
2. Training ML models with **amRml**
3. Exploring results with **amRshiny**
3. Exploring results with **amRviz**

See the individual package vignettes for detailed usage instructions.
Loading