Skip to content

Commit

Permalink
change refs from MicrobiomeDB to VEuPathDB
Browse files Browse the repository at this point in the history
  • Loading branch information
asizemore committed Oct 18, 2024
1 parent 15edb5c commit 29c61c2
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Package: veupathUtils
Title: General Helper Functions for MicrobiomeDB Projects
Title: General Helper Functions for VEuPathDB Projects
Version: 2.6.7
Authors@R:
c(person(given = "Danielle",
Expand All @@ -26,8 +26,8 @@ Depends:
jsonlite
Remotes:
zdk123/SpiecEasi
URL: https://github.com/microbiomeDB/veupathUtils
BugReports: https://github.com/microbiomeDB/veupathUtils/issues
URL: https://github.com/VEuPathDB/veupathUtils
BugReports: https://github.com/VEuPathDB/veupathUtils/issues
Description: veupathUtils contains various R helper functions intended to be useful across a variety of projects, including the plot.data and microbiomeComputations packages.
License: Apache License (>= 2)
Encoding: UTF-8
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
<!-- badges: start -->
[![R-CMD-check](https://github.com/microbiomeDB/veupathUtils/workflows/R-CMD-check/badge.svg)](https://github.com/microbiomeDB/veupathUtils/actions)
[![R-CMD-check](https://github.com/VEuPathDB/veupathUtils/workflows/R-CMD-check/badge.svg)](https://github.com/VEuPathDB/veupathUtils/actions)
<!-- badges: end -->

# veupathUtils

veupathUtils is an R package which provides helper functions for solving common problems in the MicrobiomeDB project.
veupathUtils is an R package which provides helper functions for solving common problems in the VEuPathDB project.

## Installation

Use the R package [remotes](https://cran.r-project.org/web/packages/remotes/index.html) to install veupathUtils. From the R command prompt:

```R
remotes::install_github('microbiomeDB/veupathUtils')
remotes::install_github('VEuPathDB/veupathUtils')
```

## Usage
This package is primarily intended for use as a dependency in other R packages. In order to establish that depedency the developer of the
dependent package must follow these steps:
1. add ```veupathUtils``` to the ```Imports``` section of the dependent package's ```DESCRIPTION``` file.
2. add a ```Remotes``` section to the dependent package's ```DESCRIPTION``` file.
3. add ```microbiomeDB/veupathUtils``` to the ```Remotes``` section of the dependent package's ```DESCRIPTION``` file.
3. add ```VEuPathDB/veupathUtils``` to the ```Remotes``` section of the dependent package's ```DESCRIPTION``` file.
4. add ```#' @import veupathUtils``` to the dependent package's package-level documentation file (usually called ```{mypackage}-package.R```).
5. run ```devtools::document()```.

Expand Down
6 changes: 3 additions & 3 deletions man/veupathUtils-package.Rd

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

0 comments on commit 29c61c2

Please sign in to comment.