Skip to content

Commit

Permalink
Update JOSS branch to state of release 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kuadrat committed Dec 15, 2023
2 parents 19f758a + 931f909 commit da0805a
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 34 deletions.
3 changes: 0 additions & 3 deletions CRAN-SUBMISSION

This file was deleted.

69 changes: 41 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,39 +52,52 @@ Installing from source might make sense if...
not yet available on the CRAN version but is also likely less stable,
- for some reason installation from CRAN is not an option for you.

In this case,

1. Start by cloning this repository"
```
$ git clone git@github.com:kuadrat/growR.git
```
or via https:
```
$ git clone https://github.com/kuadrat/growR.git
```
This will create a directory `growR` in your file system.
In this case, start by cloning this repository
```
$ git clone git@github.com:kuadrat/growR.git
```
or via https:
```
$ git clone https://github.com/kuadrat/growR.git
```
This will create a directory `growR` in your file system.

If you don't have or don't want to use *git*, you could alternatively copy
the source code as a .zip file from
[github](https://github.com/kuadrat/growR/archive/refs/heads/master.zip).
Unzip the contents into a directory `growR`.
2. You can now install *growR* by issuing the following at the prompt of
an `R` session:
```
install.packages("/full/path/to/growR", repos = NULL)
```
You should replace `"/full/path/to/"` with the actual path to the `growR`
directory on your computer. Also, replace slashes (`/`) with backslashe (`\`)
if you're on Windows.
`growR` should now be installed and available in `R` through
`library(growR)`.
If you don't have or don't want to use *git*, you could alternatively copy
the source code as a .zip file from
[github](https://github.com/kuadrat/growR/archive/refs/heads/master.zip).
Unzip the contents into a directory `growR`.

#### Alternative A

You can now install your local version of *growR* by issuing
the following at the prompt of an `R` session:
```
install.packages("/full/path/to/growR", repos = NULL)
```
You should replace `"/full/path/to/"` with the actual path to the `growR`
directory on your computer. Also, replace slashes (`/`) with backslashe (`\`)
if you're on Windows.

`growR` should now be installed and available in `R` through `library(growR)`.
If you make changes to the source files in the `growR` directory, just
uninstall the current version (issue `remove.packages("growR")` in `R`)
and repeat step 2 above.
and repeat this step.

#### Alternative B

If you make frequent changes to the code, it might be
unpractical to uninstall and reinstall the changed version each time. In that
case, `devtools` comes in very handy (if needed, install it with
`install.packages("devtools")`). It allows you to load a package into an active
`R` session without the need of it being properly installed. The following has
practically the equivalent result as the method described in
[alternative A](#alternative-a):
```
library(devtools)
devtools::load_all("/full/path/to/growR")
```
The notes about `"/full/path/to"` as in [Alternative A](#alternative-a) apply here as well.

### Non-package version

If you just want to focus on using and adjusting the ModVege model and feel
Expand Down
3 changes: 0 additions & 3 deletions cran-comments.md

This file was deleted.

0 comments on commit da0805a

Please sign in to comment.