Skip to content

Commit

Permalink
- upgrade website
Browse files Browse the repository at this point in the history
  • Loading branch information
jonasfoe committed Oct 6, 2019
1 parent 3d47ca0 commit 6577e66
Show file tree
Hide file tree
Showing 145 changed files with 4,846 additions and 3,419 deletions.
49 changes: 30 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,41 @@

<img src="man/figures/logo.png" alt="CoRC logo" width="200"> --- the <b>CO</b>PASI <b>R</b> <b>C</b>onnector
============================================================================================================
# <img src="man/figures/logo.png" alt="CoRC logo" width="200"> — the <b>CO</b>PASI <b>R</b> <b>C</b>onnector

Overview
--------
## Overview

Development Stage: **Beta**

CoRC, the COPASI R Connector, links the Complex Pathway Simulator COPASI ([copasi.org](http://copasi.org)) and the (statistical) programming environment R ([r-project.org](http://r-project.org)). It provides easy access to the powerful biochemical model editing, simulation and analysis backend of COPASI from the convenient R command line interface. This allows the user to develop elaborate scripts and workflows for analyses that would require a great deal of tedious manual work otherwise. These scripts can then be run interactively from the R command line interface or be sent to cluster or cloud facilities for more demanding calculations.
CoRC, the COPASI R Connector, links the Complex Pathway Simulator COPASI
([copasi.org](http://copasi.org)) and the (statistical) programming
environment R ([r-project.org](http://r-project.org)). It provides easy
access to the powerful biochemical model editing, simulation and
analysis backend of COPASI from the convenient R command line interface.
This allows the user to develop elaborate scripts and workflows for
analyses that would require a great deal of tedious manual work
otherwise. These scripts can then be run interactively from the R
command line interface or be sent to cluster or cloud facilities for
more demanding calculations.

CoRC features:

- high-level API for COPASI in the R language.
- Immediate access to R's data analysis capabilities and publication-ready plotting.
- Reproducible workflows from data generation to analysis and plotting (R scripts and notebooks).
- Rule-based modification of model structure to test structural variations or create large models.
- Scaling up assays, e.g. from 3 models to 3000.
- Handling of multiple models at once.
- Parallelization on multi-core machines or computing clusters.
- high-level API for COPASI in the R language.
- Immediate access to R’s data analysis capabilities and
publication-ready plotting.
- Reproducible workflows from data generation to analysis and plotting
(R scripts and notebooks).
- Rule-based modification of model structure to test structural
variations or create large models.
- Scaling up assays, e.g. from 3 models to 3000.
- Handling of multiple models at once.
- Parallelization on multi-core machines or computing clusters.

It is currently based on COPASI version 4.25 Build (207) and aims to closely follow COPASI releases in the future.
It is currently based on COPASI version 4.27 Build (217) and aims to
closely follow COPASI releases in the future.

CoRC comes with the Artistic License 2.0. By using CoRC you agree to this license.
CoRC comes with the Artistic License 2.0. By using CoRC you agree to
this license.

Installation
------------
## Installation

Install the development version from GitHub:

Expand All @@ -34,10 +45,10 @@ remotes::install_github("jpahle/CoRC")
CoRC::getCopasi()
```

CoRC runs it's own version of the COPASI backend which it will download via the `getCopasi` function.
CoRC runs it’s own version of the COPASI backend which it will download
via the `getCopasi` function.

Usage
-----
## Usage

``` r
library(CoRC)
Expand Down
6 changes: 3 additions & 3 deletions development/site_upgrade.R
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# For upgrading the site I want to have specific versions of relevant packages

# use specific pkgdown to keep page stable for now
remotes::install_version("pkgdown", "1.3.0", upgrade = "never")
remotes::install_version("pkgdown", "1.4.1", upgrade = "never")
# use fixed plotly versions to be able to keep the 8mb or so of plots frozen when updating the rest of the website
remotes::install_version("ggplot2", "3.1.0", upgrade = "never")
remotes::install_version("plotly", "4.8.0", upgrade = "never")
remotes::install_version("ggplot2", "3.2.1", upgrade = "never")
remotes::install_version("plotly", "4.9.0", upgrade = "never")
devtools::document()
devtools::install()
devtools::test()
Expand Down
203 changes: 203 additions & 0 deletions docs/404.html

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

Loading

0 comments on commit 6577e66

Please sign in to comment.