Closes #1247 Improve text "What is NCA?"

[jimrothstein]

Issue

Closes #1247

Description

Review background.Rmd and possible add material.
This is work-in-progress and may require discussion to be sure right material at the right level is included.

Definition of Done

A relatively new user should be able to follow the basic ideas and workflow.
Necessary definitions must be very clear ( pk curve, ADNCA format )
Add links to a curated list of documentation/videos. Several videos are excellent.

How to test

How to test features not covered by unit tests.

Contributor checklist

• Code passes lintr checks
• Code passes all unit tests
• New logic covered by unit tests
• New logic is documented
• App or package changes are reflected in NEWS
• Package version is incremented
• R script works with the new implementation (if applicable)
• Settings upload works with the new implementation (if applicable)
• If any .scss change was done, run data-raw/compile_css.R

Notes to reviewer

Anything that the reviewer should know before tacking the pull request?

SEE inst/suggestions.md

Possible inclusions?

• link to official CIDC documentation (https://www.cdisc.org/system/files/members/standard/foundational/ADaMIG_for_Non-compartmental_Analysis_Input_Data_v1.0_1.pdf)
• ADNCA format ( show trival example, ~ 5 rows)
• link to admiral https://pharmaverse.github.io/admiral/articles/pk_adnca.html

[Gero1999]

What you did will cross out the test, but what we want if it is repeated is probably to delete it

Suggested change

~~This document will help you understand the fundamentals of Non-Compartmental Analysis (NCA) in pharmacokinetics (PK) and the challenges analysts face when performing NCA. It also explains why the aNCA application was developed and how it aims to streamline and enhance the NCA workflow.~~

[jimrothstein]

@Gero1999

Strikeout

The sentence is a duplicate. The STRIKEOUT symbol is:

an old-fashioned way to propose changes to documents, before computers and CI/CD.

I will remove the strikeout from vignette.

---

As to the vignette itself:

First i want to outline my thinking and proposed changes in a separate document suggestions.md (will remove at very end). With suggestions.md, you can review my suggestions; add, discuss; etc.

If easier for you, I can keep the this document up-to-date. But appreciate if you comment, suggest additions, subtrations, etc. So consider suggestions.md a work-in-progress. If we go this way, it may take some to get it to our liking. But hopefully, make the actual changes to vignette easier.

Please see ../inst/suggestions.md (https://github.com/pharmaverse/aNCA/blob/1247_improve_text_What_is_NCA/inst/suggestions.md)

[jimrothstein]

@Gero1999

Been going through a number of videos (yours and others) and working through "ADNCA format" (ie column names, function parameters)

My "suggestions.md" (https://github.com/pharmaverse/aNCA/blob/1247_improve_text_What_is_NCA/inst/suggestions.md) is still rough and will change.

But the upshot is I think adding a bit more material will make on-boarding a little easier.

---

Made a few minor changes to "background.Rmd"; the document is already good.
Perhaps add diagram of a pk curve (concentration vs time)
But I do think a third document will help new reader (an intro to ADNCA format, workflow sketch ...)

[Gero1999]

Hey @jimrothstein , changes directly on the doc look good, thanks. Please make sure to merge main into here, the NAMESPACE file should not change with respect to main.

also don't create new .gitignore, instead just include the relevant file in the original one. Notice also we are supposed to be building the website with pkgdown / markdown