diff --git a/README.md b/README.md index f75da4d..90dc389 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,18 @@ A work-in-progress Shiny interface lives in the a separate package that depends on `singlehit`; installing `singlehit` does not install or require it. +## Prerequisites + +Check that your data can be fitted before you start. `singlehit` needs: + +- **at least 3 distinct doses**, each greater than zero; +- **more than 1 positive response in total**, summed across all doses; and +- **counts of positive and negative subjects** for every dose, not just a + response proportion. Every dose group must contain at least one subject. + +Data that fail these checks are rejected with an explanatory error. See +[Input data format](#input-data-format) for column names and the full rules. + ## Installation