Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to reflect reviewer comments #30

Merged
merged 3 commits into from
Dec 2, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
```