updates readme

Geosyntec · Sep 8, 2023 · 5b8f390 · 5b8f390
1 parent 3acee1b
commit 5b8f390
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 313 deletions.
diff --git a/R/ICE_explore.Rmd b/R/ICE_explore.Rmd
diff --git a/R/ex_drc.Rmd b/R/ex_drc.Rmd
diff --git a/README.md b/README.md
@@ -1 +1,53 @@
-# water100
+Absolutely, I've updated the README.md sample with the styling and link for ECOTOX. Here it is:
+
+---
+
+# Water100 Project
+
+## Overview
+This repository contains code for the [Water100 Project](https://water100project.org/), aimed at evaluating dose-response curves from the EPA's [ECOTOX database](https://cfpub.epa.gov/ecotox/). The code is written in R.
+
+
+## Installation
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/Geosyntec/water100.git
+   ```
+
+
+## Folder Structure
+
+* `/data`               
+     Processed data from ECOTOX
+
+
+
+* `/R`  
+     .R and .Rmd scripts for analysis
+
+* `/xlsx`   
+additional spreadsheets 
+* `/docx`   
+    Report (in progress)
+
+
+## Usage
+#### R/ecotox_eda_v6.Rmd
+
+```R/dose_response_example.R``` Provides an example of developing dose-response curves 
+```R/ecotox_eda_v6.Rmd``` ECOTOX Exploratory Data Analysis
+
+
+## Contributing
+
+1. Fork the repository.
+2. Create a new branch.
+3. Commit your changes.
+4. Create a pull request.
+
+
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE.md](LICENSE.md) for details.