Skip to content

Commit

Permalink
Update readme and vignettes
Browse files Browse the repository at this point in the history
  • Loading branch information
shannarucker committed Jan 14, 2025
1 parent 762aafe commit 0869207
Show file tree
Hide file tree
Showing 11 changed files with 203 additions and 101,926 deletions.
12 changes: 7 additions & 5 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,14 @@ devtools::install_github("LimnoTech/SCI")

Produce the SCI scores in just a few simple steps:

1. In RStudio, open the [workflow.R](https://github.com/LimnoTech/SCI/blob/master/workflow.R) script.
1. Complete the [pre-processing steps](https://limnotech.github.io/SCI/articles/pre-processing.html), as needed.

2. Update the "Input Variables" section of the script and confirm the latest data files are saved in the [data](https://github.com/LimnoTech/SCI/tree/master/data) folder.
2. In RStudio, open the [workflow.R](https://github.com/LimnoTech/SCI/blob/master/workflow.R) script.

3. Update [lookup_tables.xlsx](https://github.com/LimnoTech/SCI/blob/master/data/lookup_tables.xlsx) and run code from the "Lookup Tables" section of the script, as needed. Note: this step is not typically necessary.
3. Update the "Input Variables" section of the script and confirm the latest data files are saved in the [data](https://github.com/LimnoTech/SCI/tree/master/data) folder.

4. Click the Source button to run the script.
4. Update [lookup_tables.xlsx](https://github.com/LimnoTech/SCI/blob/master/data/lookup_tables.xlsx) and run code from the "Lookup Tables" section of the script, as needed. Note: this step is not typically necessary.

5. View the results in [all_scores.csv](https://github.com/LimnoTech/SCI/blob/master/all_scores.csv).
5. Click the Source button to run the workflow.R script.

6. View the results in [all_scores.csv](https://github.com/LimnoTech/SCI/blob/master/all_scores.csv).
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,24 @@ devtools::install_github("LimnoTech/SCI")

Produce the SCI scores in just a few simple steps:

1. In RStudio, open the
1. Complete the [pre-processing
steps](https://limnotech.github.io/SCI/articles/pre-processing.html),
as needed.

2. In RStudio, open the
[workflow.R](https://github.com/LimnoTech/SCI/blob/master/workflow.R)
script.

2. Update the “Input Variables” section of the script and confirm the
3. Update the “Input Variables” section of the script and confirm the
latest data files are saved in the
[data](https://github.com/LimnoTech/SCI/tree/master/data) folder.

3. Update
4. Update
[lookup_tables.xlsx](https://github.com/LimnoTech/SCI/blob/master/data/lookup_tables.xlsx)
and run code from the “Lookup Tables” section of the script, as
needed. Note: this step is not typically necessary.

4. Click the Source button to run the script.
5. Click the Source button to run the workflow.R script.

5. View the results in
6. View the results in
[all_scores.csv](https://github.com/LimnoTech/SCI/blob/master/all_scores.csv).
26 changes: 0 additions & 26 deletions all_scores.csv

This file was deleted.

Binary file modified data/lookup_tables.xlsx
Binary file not shown.
Loading

0 comments on commit 0869207

Please sign in to comment.