Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
dkesada committed Apr 6, 2020
1 parent 44dc2be commit 2e8f3cd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
12 changes: 8 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ An implementation of Gaussian dynamic Bayesian networks (GDBN) structure learnin

## Current development

As of today (17/03/2020), the main functionality of the package is running and working. In order of importance, the primary objectives are:
As of today (06/04/2020), the main functionality of the package is running and working. In order of importance, the primary objectives are:

* To add examples of the main functionality of the package and fix R CMD checks in order to upload it to CRAN
* To add an automatically generated shiny interface of the net
* To run testing of some known unexpected behaviours on bn and dbn prediction (e.g. providing all variables as objective variables)
* To add the possibility of learning nets with only certain previous lags instead of all of them. For example, a dbn with only the time slices for t_0 and t_12, or one with t_0, t_3 and t_4.
Expand All @@ -31,7 +30,7 @@ For now, the dbn.fit object as an extension of bnlearn's bn.fit object will stay

### Prerequisites

This package requires R ≥ 3.6.1 to work properly. It's possible to make it work for older versions of R and of each of the packages by fiddling with the [DESCRIPTION](DESCRIPTION) file, although this is not recommended.
This package requires R ≥ 3.6.1 to work properly. It also works for R ≥ 3.5.0, the only difference is the color palette of the DBN visualization tool.

The __bnlearn__ and __data.table__ packages, among others, are required for this package to work. They will be installed automatically when installing this package. They can also be installed manually via CRAN with the command

Expand All @@ -42,7 +41,12 @@ install.packages(c("bnlearn", "data.table"))
The packages __visNetwork__, __magrittr__ and __grDevices__ are optional for the visualization tool. They will only be required if you want to use it.

### Installing
As of today, the easiest way of installing dbnR is via the _install_github_ function in the __devtools__ package. The commands you need to run are
As of today, the easiest way of installing dbnR is via CRAN. To install it, simply run
```{r inst_CRAN, echo=TRUE, eval=FALSE}
install.packages('dbnR')
```

You can also install the lastest version in GitHub with the _install_github_ function in the __devtools__ package. The commands you need to run are
```{r inst, echo=TRUE, eval=FALSE}
library(devtools)
devtools::install_github("dkesada/dbnR")
Expand Down
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@ implemented for GDBNs and bnlearn’s BNs via the visNetwork package

## Current development

As of today (17/03/2020), the main functionality of the package is
As of today (06/04/2020), the main functionality of the package is
running and working. In order of importance, the primary objectives are:

- To add examples of the main functionality of the package and fix R
CMD checks in order to upload it to CRAN
- To add an automatically generated shiny interface of the net
- To run testing of some known unexpected behaviours on bn and dbn
prediction (e.g. providing all variables as objective variables)
Expand All @@ -42,10 +40,9 @@ Not an elegant solution, but its simplicity is enough.

### Prerequisites

This package requires R ≥ 3.6.1 to work properly. It’s possible to make
it work for older versions of R and of each of the packages by fiddling
with the [DESCRIPTION](DESCRIPTION) file, although this is not
recommended.
This package requires R ≥ 3.6.1 to work properly. It also works for R ≥
3.5.0, the only difference is the color palette of the DBN visualization
tool.

The **bnlearn** and **data.table** packages, among others, are required
for this package to work. They will be installed automatically when
Expand All @@ -62,7 +59,14 @@ use it.

### Installing

As of today, the easiest way of installing dbnR is via the
As of today, the easiest way of installing dbnR is via CRAN. To install
it, simply run

``` r
install.packages('dbnR')
```

You can also install the lastest version in GitHub with the
*install\_github* function in the **devtools** package. The commands you
need to run are

Expand Down

0 comments on commit 2e8f3cd

Please sign in to comment.