Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Logo added #90

Merged
merged 5 commits into from
Jan 8, 2024
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
8 changes: 4 additions & 4 deletions .github/workflows/check-bioc-devel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,10 @@ jobs:
## https://github.com/r-lib/remotes/issues/296
## Ideally, all dependencies should get installed in the first pass.
# BiocManager::install("vegandevs/vegan")
BiocManager::install("vegan")
BiocManager::install("fionarhuang/TreeSummarizedExperiment")
BiocManager::install("microbiome/mia")
BiocManager::install("microbiome/miaViz")
# BiocManager::install("vegan")
# BiocManager::install("fionarhuang/TreeSummarizedExperiment")
# BiocManager::install("microbiome/mia")
# BiocManager::install("microbiome/miaViz")
# remotes::install_github("microbiome/miaTime")

# rspm is out of date
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: miaSim
Type: Package
Version: 1.7.8
Version: 1.9.1
Authors@R:
c(person(given = "Yagmur", family = "Simsek", role = c("cre", "aut"),
email = "[email protected]"),
Expand Down
40 changes: 22 additions & 18 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,10 @@

## miaSim

This miaSim R/Bioconductor package can be used to simulate
(longitudinal) data for the benchmarking and analysis of quantitative
models of microbial communities.

For installation and use, see the [Getting
started](https://microbiome.github.io/miaSim/articles/miaSim.html)
page.

The package is based on the `(Tree)SummarizedExperiment` data
container that supports microbiome data analysis. The package
[homepage](https://microbiome.github.io/miaSim/) provides further
tutorials and references for the [implemented
This R/Bioconductor package provides tools to simulate (longitudinal)
time series data from popular models in microbial ecology. The
[homepage](https://microbiome.github.io/miaSim/) provides tutorials
and references for the [implemented
models](https://microbiome.github.io/miaSim/reference/index.html):

* Self-organised instability (SOI)
Expand All @@ -35,7 +27,14 @@ models](https://microbiome.github.io/miaSim/reference/index.html):
* Stochastic logistic model
* Consumer-resource model

These methods can be used for _in silico_ studies of microbial
community dynamics or multi-omic or host-microbiome interactions. The
miaSim package supports the Bioconductor [multi-assay data science
framework](https://microbiome.github.io/OMA) for multi-omic data
integration and time series analysis, and utilizes the
`(Tree)SummarizedExperiment` data container.

[Getting started](https://microbiome.github.io/miaSim/articles/miaSim.html).


### miaSimShiny
Expand Down Expand Up @@ -63,6 +62,13 @@ flow kind of approach. Development version should be done against the
We are grateful to all
[contributors](https://github.com/microbiome/miaSim/graphs/contributors).

This research has received funding from

* the Horizon 2020 Programme of the European Union within the [FindingPheno project](https://www.findingpheno.eu/) under grant agreement No 952914.
* Research Council of Finland (grant 330887)


<img src="man/figures/FindingPheno2.jpg" alt="FindingPheno logo" style="height: 50px"/>

### Citing the package

Expand All @@ -74,12 +80,10 @@ Gao _et al._ (2023). Methods in Ecology and Evolution. DOI:
For citation details, see R command `citation("miaSim")`.


# Code of conduct

Please note that the project is released with a [Bioconductor Code of
Conduct](https://bioconductor.github.io/bioc_coc_multilingual/).
By contributing to this project, you agree to abide by its terms.

**Code of conduct** Please note that the project is released with a
[Bioconductor Code of
Conduct](https://bioconductor.github.io/bioc_coc_multilingual/). By
contributing to this project, you agree to abide by its terms.


[github-watch-badge]: https://img.shields.io/github/watchers/microbiome/miaSim.svg?style=social
Expand Down
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
[![Gitter](https://badges.gitter.im/microbiome/mia.svg)](https://gitter.im/microbiome/miaverse)
[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]

[![R-CMD-check](https://github.com/microbiome/miaSim/workflows/R-CMD-check/badge.svg)](https://github.com/microbiome/miaSim/actions)
<!-- badges: end -->

Expand All @@ -15,18 +14,10 @@

## miaSim

This miaSim R/Bioconductor package can be used to simulate
(longitudinal) data for the benchmarking and analysis of quantitative
models of microbial communities.

For installation and use, see the [Getting
started](https://microbiome.github.io/miaSim/articles/miaSim.html)
page.

The package is based on the `(Tree)SummarizedExperiment` data
container that supports microbiome data analysis. The package
[homepage](https://microbiome.github.io/miaSim/) provides further
tutorials and references for the [implemented
This R/Bioconductor package provides tools to simulate (longitudinal)
time series data from popular models in microbial ecology. The
[homepage](https://microbiome.github.io/miaSim/) provides tutorials
and references for the [implemented
models](https://microbiome.github.io/miaSim/reference/index.html):

* Self-organised instability (SOI)
Expand All @@ -36,7 +27,14 @@ models](https://microbiome.github.io/miaSim/reference/index.html):
* Stochastic logistic model
* Consumer-resource model

These methods can be used for _in silico_ studies of microbial
community dynamics or multi-omic or host-microbiome interactions. The
miaSim package supports the Bioconductor [multi-assay data science
framework](https://microbiome.github.io/OMA) for multi-omic data
integration and time series analysis, and utilizes the
`(Tree)SummarizedExperiment` data container.

[Getting started](https://microbiome.github.io/miaSim/articles/miaSim.html).


### miaSimShiny
Expand Down Expand Up @@ -64,6 +62,13 @@ flow kind of approach. Development version should be done against the
We are grateful to all
[contributors](https://github.com/microbiome/miaSim/graphs/contributors).

This research has received funding from

* the Horizon 2020 Programme of the European Union within the [FindingPheno project](https://www.findingpheno.eu/) under grant agreement No 952914.
* Research Council of Finland (grant 330887)


<img src="man/figures/FindingPheno2.jpg" alt="FindingPheno logo" style="height: 50px"/>

### Citing the package

Expand All @@ -75,12 +80,10 @@ Gao _et al._ (2023). Methods in Ecology and Evolution. DOI:
For citation details, see R command `citation("miaSim")`.


# Code of conduct

Please note that the project is released with a [Bioconductor Code of
Conduct](https://bioconductor.github.io/bioc_coc_multilingual/).
By contributing to this project, you agree to abide by its terms.

**Code of conduct** Please note that the project is released with a
[Bioconductor Code of
Conduct](https://bioconductor.github.io/bioc_coc_multilingual/). By
contributing to this project, you agree to abide by its terms.


[github-watch-badge]: https://img.shields.io/github/watchers/microbiome/miaSim.svg?style=social
Expand Down
8 changes: 4 additions & 4 deletions docs/404.html

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

6 changes: 3 additions & 3 deletions docs/LICENSE-text.html

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

Loading
Loading