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.

Sign up for GitHub

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

small updates to readme file #14

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

small updates to readme file #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 9 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This should detail how to setup a local environment that enables developers to k

### Running

#### Using Packrat
#### Using Packrat (outside of R Studio)

To restore the current project you can run the following from within the R console:

Expand All @@ -46,6 +46,7 @@ packrat::restore()
If you need to add packages to this project, always run `packrat::snapshot()` before committing and see [Styling](#styling). This will add any new dependencies to the packrat.lock file.

#### Using RStudio

To run the application locally, you can install the packages above in RStudio, and use the function `runApp()` to start.

Note: You may need to install **devtools** and **tidyext** from the console manually:
Expand All @@ -54,9 +55,6 @@ install.package("devtools")
devtools::install_github('m-clark/tidyext')
```

#### Using shinyServer
Instructions on how to run the application on a shiny server.

## Styling

This project includes the [styler package](https://github.com/r-lib/styler) to maintain consistent styles throughout the codebase. Before making any PRs please be sure to run the styler on your newly written code.
Expand All @@ -65,6 +63,10 @@ Run the following in the R console:

`source("tools/styler.R")`

Or Run in Bash, sh, zsh, etc

`Rscript tools/styler.R`

If you add new files or directories please include them in `tools/styler.R` and `tools/lintr.R` scripts. By default, the styler script includes everything under `/function` directory. The syntax used is:

`wd = Current working directory`
Expand All @@ -87,13 +89,15 @@ ShinyApp searches for the following in the root folder:
- staff_projection.Rproj
- Rstudio project
- functions/
- user defined functions that used in serve.R and UI.R
- Contains functions used in serve.R and UI.R
- data/
- default datasets, e.g default staffing ratios table, were used in the app
- packrat/
- used for project package management
- www/
- Accessible to the users web browser (for assets).
- tools/
- provides the user tools for linting/styling. See [Styling](#styling).

## Further Information

Expand Down