Skip to content

Commit

Permalink
Merge pull request #30 from JGCRI/docs
Browse files Browse the repository at this point in the history
Update docs to reflect reviewer comments
  • Loading branch information
evanoffPNNL authored Dec 2, 2020
2 parents 5e86b30 + 54fa7b5 commit 9ea85a1
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,31 @@ To install hectorui as an R package for local use, please follow these steps in
- library(devtools)
- devtools::install_github("JGCRI/hectorui")

To run the app after installation, the method depends on your R environment. If you are using RStudio, simply open the server.r or ui.r file and hit "> Run App". If you are working in a command line environment, start R.exe and enter the following command: shiny::runApp(system.file("shinyApp",package = "hectorui")).
## Developing Locally
How you launch the app after installation depends on your R environment. See the following.

#### For RStudio Users
If you are using RStudio, simply open the `server.r` or `ui.r` file and execute `Run App`.

#### For CMD Users
Start `R.exe` and enter the following command:

```R
shiny::runApp(system.file("shinyApp", package = "hectorui"))
```

#### Adding New Features
Users familiar with R Shiny can add new features by working directly in the `hectorui/inst/shinyApp` directory.

## Contributing to `hectorui`

We welcome contributions to `hectorui` from the development community. Please contact us if you want to collaborate! The `hectorui` GitHub repository is accessible here: [`hector-ui` GitHub Repository](https://github.com/JGCRI/hectorui)

For more information about contributing, please contact Jason Evanoff at jason.evanoff@pnnl.gov or Chris Vernon at chris.vernon@pnnl.gov

## Learn More About Hector
Read more about the Hector simple climate model here: [`Hector` Documentation](https://jgcri.github.io/hector/). `Hector` has been published in the following:

```
Hartin CA, Patel P, Schwarber A, Link R, Bond-Lamberty B (2015). “A simple object-oriented and open-source model for scientific and policy analyses of the global climate system–Hector v1.0.” Geoscientific Model Development, 8(4), 939–955.
```

0 comments on commit 9ea85a1

Please sign in to comment.