Skip to content

Commit

Permalink
docs: add installation instructions from cran
Browse files Browse the repository at this point in the history
  • Loading branch information
johannes-titz committed Jul 5, 2024
1 parent dc90f86 commit b3b90db
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 14 deletions.
12 changes: 9 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,13 @@ Cofad has two components, the plain R package and a shiny-app that offers an int

If you just want to use the cofad-app, you do not need to install it. Just go to https://cofad.titz.science and use it there. An example data file is loaded when you add /example after the url.

If you prefer the command line interface or want to use the cofad-app locally, install it from github (you need the package devtools for this):
If you prefer the command line interface or want to use the cofad-app locally, install it from CRAN:

```{r}
install.packages("cofad")
```

Alternatively, you can also install the development version from github (you need the package devtools for this):

```{r echo = T, results = "hide", eval = F}
# install.packages("devtools") # uncomment if you do not have devtools installed
Expand All @@ -90,9 +96,9 @@ You can also run the app:
cofad::run_app()
```

If you have any problems installing cofad, check that your R version is up to date (currently `r version$version.string`). If you are using Windows, enable TLS 1.2 in the Internet Options Advanced tab (see https://github.com/r-lib/remotes/issues/130#issuecomment-423830669). Under Windows, you will also need Rtools to build the package: https://cran.r-project.org/bin/windows/Rtools/.
<!-- If you have any problems installing cofad, check that your R version is up to date (currently `r version$version.string`). If you are using Windows, enable TLS 1.2 in the Internet Options Advanced tab (see https://github.com/r-lib/remotes/issues/130#issuecomment-423830669). Under Windows, you will also need Rtools to build the package: https://cran.r-project.org/bin/windows/Rtools/. -->

If it still does not work drop an e-mail at johannes at titz.science or at johannes.titz at gmail.com.
<!-- If it still does not work drop an e-mail at johannes at titz.science or at johannes.titz at gmail.com. -->

## Using cofad

Expand Down
23 changes: 12 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,16 @@ Just go to <https://cofad.titz.science> and use it there. An example
data file is loaded when you add /example after the url.

If you prefer the command line interface or want to use the cofad-app
locally, install it from github (you need the package devtools for
this):
locally, install it from CRAN:

``` r
install.packages("cofad")
#> Installing package into '/tmp/Rtmpl1xjgl/temp_libpath342fc6426ca78'
#> (as 'lib' is unspecified)
```

Alternatively, you can also install the development version from github
(you need the package devtools for this):

``` r
# install.packages("devtools") # uncomment if you do not have devtools installed
Expand All @@ -88,15 +96,8 @@ You can also run the app:
cofad::run_app()
```

If you have any problems installing cofad, check that your R version is
up to date (currently R version 4.4.1 (2024-06-14)). If you are using
Windows, enable TLS 1.2 in the Internet Options Advanced tab (see
<https://github.com/r-lib/remotes/issues/130#issuecomment-423830669>).
Under Windows, you will also need Rtools to build the package:
<https://cran.r-project.org/bin/windows/Rtools/>.

If it still does not work drop an e-mail at johannes at titz.science or
at johannes.titz at gmail.com.
<!-- If you have any problems installing cofad, check that your R version is up to date (currently R version 4.4.1 (2024-06-14)). If you are using Windows, enable TLS 1.2 in the Internet Options Advanced tab (see https://github.com/r-lib/remotes/issues/130#issuecomment-423830669). Under Windows, you will also need Rtools to build the package: https://cran.r-project.org/bin/windows/Rtools/. -->
<!-- If it still does not work drop an e-mail at johannes at titz.science or at johannes.titz at gmail.com. -->

## Using cofad

Expand Down

0 comments on commit b3b90db

Please sign in to comment.