Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
[email protected] committed Jun 18, 2024
1 parent ca54662 commit 3f6b819
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Python library for the calculation of **B**ench**M**ark **D**ose **R**esponse **

# General Schematic

The main bmdrc function was built to calculate benchmark dose (BMD) response curves for dichotomous (morphological) and light photomotor response datasets, where continuous variables are transformed to dichotomous as described in [Thomas et al 2019](https://www.sciencedirect.com/science/article/pii/S2468111318300732). Potential outputted files include a csv file of all final BMDs and their estimation errors, a csv file of model fits (AIC) for each endpoint, and an html report containing information on how much data was filtered and why, as well as interactive response curve plots. Users may specify their outputs of interest.
The bmdrc library was built to calculate benchmark dose (BMD) response curves for dichotomous (morphological) and light photomotor response datasets, where continuous variables are transformed to dichotomous as described in [Thomas et al 2019](https://www.sciencedirect.com/science/article/pii/S2468111318300732). Potential outputted files include a csv file of all final BMDs and their estimation errors, a csv file of model fits (AIC) for each endpoint, and an html report containing information on how much data was filtered and why, as well as interactive response curve plots. Users may specify their outputs of interest.

![General bmdrc inputs and outputs](./bmdrc.png)

Expand All @@ -18,6 +18,16 @@ The main bmdrc function was built to calculate benchmark dose (BMD) response cur

5. *Output Modules:* Select tables to output as csvs. View plots in a HTML report.

# How to install the package

First, install the package from pip using:

`pip install bmdrc`

Or from github using:

`pip install git+https://github.com/PNNL-CompBio/bmdrc`

# How to use the package

### Vignettes
Expand Down
9 changes: 0 additions & 9 deletions vignettes/LPR Class Example.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -890,15 +890,6 @@
"response = LPR.output_res_benchmark_dose\n",
"response"
]
},
{
"cell_type": "code",
"execution_count": 15,
"metadata": {},
"outputs": [],
"source": [
"LPR.report(out_folder = \"/Users/degn400/Downloads/LPR_Out\")"
]
}
],
"metadata": {
Expand Down

0 comments on commit 3f6b819

Please sign in to comment.