Skip to content

Commit

Permalink
update github repo readme with updates from oct and nov
Browse files Browse the repository at this point in the history
  • Loading branch information
evaham1 committed Nov 22, 2024
1 parent bbdac47 commit b61605b
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 11 deletions.
62 changes: 52 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

<!-- PLEASE DO NOT EDIT ./README.md BY HAND, EDIT ./inst/README.Rmd AND RENDER TO CREATE ./README.md -->

[![](https://img.shields.io/badge/release%20version-6.28.0-green.svg)](https://www.bioconductor.org/packages/mixOmics)
[![download](http://www.bioconductor.org/shields/downloads/release/mixOmics.svg)](https://bioconductor.org/packages/stats/bioc/mixOmics)
[![R build
status](https://github.com/mixOmicsteam/mixOmics/workflows/R-CMD-check.yml/badge.svg)](https://github.com/mixOmicsteam/mixOmics/actions)
Expand Down Expand Up @@ -43,22 +42,22 @@ BiocManager::install('mixOmics')
library(mixOmics)
```

You can also install the [development
version](https://github.com/mixOmicsTeam/mixOmics/tree/development) for
new features yet to be widely tested:

``` r
BiocManager::install("mixOmicsTeam/mixOmics@development")
```

### From Github

Bioconductor versions are updated twice a year, between these updates
you can downlod the latest stable version of `mixOmics` from `Github`
using:

``` r
devtools::install_github("mixOmicsTeam/mixOmics")
BiocManager::install('mixOmicsTeam/mixOmics')
```

You can also install the [development
version](https://github.com/mixOmicsTeam/mixOmics/tree/development) for
new features yet to be widely tested:

``` r
BiocManager::install("mixOmicsTeam/mixOmics@development")
```

### From `Docker` container
Expand Down Expand Up @@ -268,6 +267,49 @@ Thank you for using `mixOmics`!

## What’s New

#### November 2024

- enhancement request
[\#216](https://github.com/mixOmicsTeam/mixOmics/issues/216)
implemented parallel processing using `BPPARAM` across all `tune()`
functions

- feature request
[\#335](https://github.com/mixOmicsTeam/mixOmics/issues/335) added
`seed` argument to `perf()` functions for better reproducibility

- feature request
[\#334](https://github.com/mixOmicsTeam/mixOmics/issues/334) added
`seed` argument to `tune()` functions for better reproducibility

- bug fix implemented for
[\#307](https://github.com/mixOmicsTeam/mixOmics/issues/307)
`plotIndiv()` ellipses colours not matching points, now sample group
order is respected and colours can be customised for points and
ellipses

- updated documentation to fix issue
[\#297](https://github.com/mixOmicsTeam/mixOmics/issues/297) broken
link in bookdown vignette

- updated documentation to fix issue
[\#296](https://github.com/mixOmicsTeam/mixOmics/issues/296) typo in
vignette

#### October 2024

\*\* Version 6.30.0 \*\*

[Bioconductor release version
6.30.0](https://bioconductor.org/packages/release/bioc/html/mixOmics.html)
released end of October 2024 Minor bug fixes and updated deprecated code
and unit tests, no major code changes and no changes to user experience
of mixOmics.

- bug fix implemented for
[\#293](https://github.com/mixOmicsTeam/mixOmics/issues/293)
`splsda()` example code error

#### March 2022

- bug fix implemented for [Issue
Expand Down
19 changes: 19 additions & 0 deletions inst/README-WhatsNew.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,25 @@ opts_chunk$set( echo = TRUE, eval = FALSE, warning = FALSE, message = FALSE)

## What's New

#### November 2024

* enhancement request [#216](https://github.com/mixOmicsTeam/mixOmics/issues/216) implemented parallel processing using `BPPARAM` across all `tune()` functions
* feature request [#335](https://github.com/mixOmicsTeam/mixOmics/issues/335) added `seed` argument to `perf()` functions for better reproducibility
* feature request [#334](https://github.com/mixOmicsTeam/mixOmics/issues/334) added `seed` argument to `tune()` functions for better reproducibility

* bug fix implemented for [#307](https://github.com/mixOmicsTeam/mixOmics/issues/307) `plotIndiv()` ellipses colours not matching points, now sample group order is respected and colours can be customised for points and ellipses

* updated documentation to fix issue [#297](https://github.com/mixOmicsTeam/mixOmics/issues/297) broken link in bookdown vignette
* updated documentation to fix issue [#296](https://github.com/mixOmicsTeam/mixOmics/issues/296) typo in vignette

#### October 2024
** Version 6.30.0 **

[Bioconductor release version 6.30.0](https://bioconductor.org/packages/release/bioc/html/mixOmics.html) released end of October 2024
Minor bug fixes and updated deprecated code and unit tests, no major code changes and no changes to user experience of mixOmics.

* bug fix implemented for [#293](https://github.com/mixOmicsTeam/mixOmics/issues/293) `splsda()` example code error

#### March 2022

* bug fix implemented for [Issue #196](https://github.com/mixOmicsTeam/mixOmics/issues/196). `perf()` can now handle features with a `(s)pls` which have near zero variance.
Expand Down
1 change: 0 additions & 1 deletion inst/README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ pkg_license <- read.dcf("../DESCRIPTION")[, "License"]
pkg_license_badge <- sprintf("https://img.shields.io/badge/license-%s-lightgrey.svg", pkg_license)
```

`r badge_bioc_release("mixOmics", "green")`
`r badge_bioc_download_rank('mixOmics')`
`r badge_github_actions(re = "mixOmicsteam/mixOmics", action = "R-CMD-check.yml")`
`r badge_last_commit("mixOmicsTeam/mixOmics", branch='master')`
Expand Down

0 comments on commit b61605b

Please sign in to comment.