-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PR changes suggested by @kellijohnson-NOAA
- Loading branch information
1 parent
96b001c
commit 53b22fd
Showing
2 changed files
with
4 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,12 +1,9 @@ | ||
# User guide | ||
|
||
This section details installation guides for | ||
[users](#user-installation-guide). See the [developer installation | ||
[users](#user-installation-guide). For developers, see the [developer installation | ||
guide](#developer-software-and-installation-guide). | ||
|
||
## User Installation Guide | ||
This section describes how to install the FIMS R package and dependencies. | ||
|
||
## Installing the package from R universe | ||
|
||
The following software is required: | ||
|
@@ -18,37 +15,6 @@ Install the latest precompiled version [FIMS from R universe](https://noaa-fims | |
install.packages("FIMS", repos = c("https://noaa-fims.r-universe.dev", "https://cloud.r-project.org")) | ||
``` | ||
|
||
## Running the model | ||
|
||
This section describes how to set-up and run the model. | ||
|
||
### Specifying the model | ||
|
||
#### Naming conventions | ||
TODO: add description and link to naming conventions | ||
|
||
#### Structuing data input | ||
You can add components to the model using S4 classes. | ||
```{r} | ||
#TODO: add script to demonstrate how to structure data input | ||
``` | ||
|
||
#### Defining model specifications | ||
```{r} | ||
#TODO: add scripts detailing how to set up different components of the model | ||
``` | ||
|
||
### How to run the model | ||
```{r} | ||
#TODO: add script with examples on how to run the model | ||
``` | ||
|
||
### Extracting model output | ||
|
||
Here is how you get the model output. | ||
|
||
```{r} | ||
#Todo add code for how to extract model output | ||
``` | ||
|
||
## Running FIMS | ||
|
||
See the [Introducing FIMS vignette](https://noaa-fims.github.io/FIMS/articles/fims-demo.html). | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
iantaylor-NOAA
Contributor
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🙏 @k-doering-NOAA for leaving "breadcrumbs" for readers. I have been reading about good documentation and this is a "key" aspect that has been listed.
@iantaylor-NOAA would this change be sufficient for you to close #117?