Polish Documentation for AUC functions and vignette

[sedavid01]

This ticket is an extension of the necessary documentation polishing from the get_AUC function issue, the AUC wrapper function, and the applicable vignette.

Goal: Have production level documentation for package users, this should be readily understood by users from statisticians, wet-lab scientists, other researchers, and students learning the package.

Function documentation:

• [x] Each function should have a title
• [x] Each function should have a 3-5 sentence description - including any applicable equations
• [x] Each function argument should have a brief and clear description - include default input (if applicable) & structure/type of input
• [x] Each function should have a brief and clear description of the output

Vignette:

• [x] Clear outline
• [x] Brief overview/introduction
• [x] Example for various applicable situations
• [x] Clear descriptions to walk users through the examples
• [x] Plots with clear figure legends and figure captions
• [x] #53

[gracezhihuizhao]

Hi @brown-jason, I'm using an example from tcplfit2 vignette in the AUC function documentation and wanted to add a link to the vignette. There are two options of doing this. Which option do you suggest?

Option 1: use the web link, but it does not match what we have currently in the package Example: Taking some example data for negative curves from example 3 in the [tcplfit2 vignette](https://cran.r-project.org/web/packages/tcplfit2/vignettes/tcplfit2-vignette.html) Option2: since vignettes are all in the same directory I can just use the file name Example: Taking some example data for negative curves from example 3 in the [tcplfit2 vignette](tcplfit2-vignette.html)

[sedavid01]

@gracezhihuizhao, before merging this ticket into 'dev' can you please run through the check list in the description and make sure to check the boxes if they are done. If there are remaining tasks, please update those and notify me in the PR before merging. Thanks, -Sarah

[sedavid01]

All of the needs are met in this ticket. The session information task was converted to a ticket and will be resolved later.

[sedavid01]

Hi @brown-jason, I'm using an example from tcplfit2 vignette in the AUC function documentation and wanted to add a link to the vignette. There are two options of doing this. Which option do you suggest?

Option 1: use the web link, but it does not match what we have currently in the package Example: Taking some example data for negative curves from example 3 in the [tcplfit2 vignette](https://cran.r-project.org/web/packages/tcplfit2/vignettes/tcplfit2-vignette.html) Option2: since vignettes are all in the same directory I can just use the file name Example: Taking some example data for negative curves from example 3 in the [tcplfit2 vignette](tcplfit2-vignette.html)

Going to convert this question to a ticket for resolution later. Not going to consider this as a blocker for the current PR.

[sedavid01]

This pull request was approved and merged into 'dev'. Closing out this ticket any further development can be opened in a new ticket.