add tutorial and readme link updates

README.md

@@ -1,3 +1,5 @@
 # intro-to-masswater
 
-Materials for a short Quarto presentation on MassWateR
+Materials for a short Quarto presentation on MassWateR: [link](https://massbays-tech.github.io/intro-to-masswater)
+
+Tutorial: [link](https://massbays-tech.github.io/intro-to-masswater/tutorial.html)

tutorial.qmd

@@ -0,0 +1,133 @@
+---
+title: "MassWateR Tutorial"
+format: 
+  html:
+    theme: styles.scss
+editor: visual
+
+execute:
+  warning: false
+  message: false
+---
+
+# Introduction
+
+In this tutorial, we will explore how to use the `MassWateR` package in R to analyze water quality data. The `MassWateR` package is a useful tool for environmental scientists and researchers who work with water quality data. We will go through the provided code step by step.
+
+## Step 1: Install and Load MassWateR
+
+Before using the `MassWateR` package, you need to install it and load it into your R session. Run the following commands:
+
+```{r}
+#| eval: false
+# Install and load the MassWateR package
+install.packages("MassWateR")
+library(MassWateR)
+```
+```{r}
+#| eval: true
+#| echo: false
+library(MassWateR)
+```
+
+## Step 2: Import Data
+
+Next, you'll import the required datasets: results data, data quality objectives files for accuracy, frequency, and completeness, site metadata, and WQX metadata. You can use the provided example datasets or your own data. The example datasets are available in the `MassWateR` package. To import your own data, you'll need to save your data as Excel files and specify the file paths in the code below.
+
+```{r}
+# Import results data
+respth <- system.file('extdata/ExampleResults.xlsx', package = 'MassWateR')
+resdat <- readMWRresults(respth)
+
+# Import dqo accuracy data
+accpth <- system.file('extdata/ExampleDQOAccuracy.xlsx', package = 'MassWateR')
+accdat <- readMWRacc(accpth)
+
+# Import dqo frequency and completeness data
+frecompth <- system.file('extdata/ExampleDQOFrequencyCompleteness.xlsx', package = 'MassWateR')
+frecomdat <- readMWRfrecom(frecompth)
+
+# Import site data
+sitpth <- system.file('extdata/ExampleSites.xlsx', package = 'MassWateR')
+sitdat <- readMWRsites(sitpth)
+
+# Import WQX meta data
+wqxpth <- system.file('extdata/ExampleWQX.xlsx', package = 'MassWateR')
+wqxdat <- readMWRwqx(wqxpth)
+```
+
+## Step 3: Create a List of Data Frames
+
+Now, you'll create a list of input data frames for further analysis.
+
+```{r}
+# Create a list of input data frames
+fsetls <- list(res = resdat, acc = accdat, frecom = frecomdat, sit = sitdat, wqx = wqxdat)
+```
+
+## Step 4: Outliers, QC, Analysis, and WQX
+
+You can perform various analyses on your water quality data using the `MassWateR` package. Here are some examples:
+
+### View Outlier Plot
+
+```{r}
+# View outlier plot for Dissolved Oxygen (DO) by month
+anlzMWRoutlier(fset = fsetls, param = "DO", group = "month")
+```
+
+### Create Outlier Plots for All Parameters
+
+```{r}
+#| eval: false
+# Create outlier plots for all parameters by month and save them to the working directory
+anlzMWRoutlierall(fset = fsetls, group = "month", output_dir = getwd())
+```
+
+### Create QC Report
+
+```{r}
+#| eval: false
+# Create a quality control (QC) report and save it to the working directory
+qcMWRreview(fset = fsetls, output_dir = getwd())
+```
+
+### View Summary of Seasonal Distributions
+
+```{r}
+# View a summary of seasonal distributions of DO for "fresh" water
+anlzMWRseason(fset = fsetls, param = "DO", thresh = "fresh")
+```
+
+### View Time Series
+
+```{r}
+# View a time series of DO for specific sites in "fresh" water
+anlzMWRdate(fset = fsetls, param = "DO", thresh = "fresh", site = c("ABT-026", "ABT-077"))
+```
+
+### View Summary of Site Results
+
+```{r}
+# View a summary of site results for DO in "fresh" water
+anlzMWRsite(fset = fsetls, param = "DO", thresh = "fresh")
+```
+
+### View Map of Results
+
+```{r}
+# View a map of DO results
+anlzMWRmap(fset = fsetls, param = "DO")
+```
+
+### Create Output for WQX Submission
+
+```{r}
+#| eval: false
+# Create an output file for WQX (Water Quality Exchange) submission in the working directory
+tabMWRwqx(fset = fsetls, output_dir = getwd())
+```
+
+# Conclusion
+
+You've learned how to use the `MassWateR` package to import and analyze water quality data in R. Feel free to modify and extend these analyses to suit your specific research needs.