-
Notifications
You must be signed in to change notification settings - Fork 11
Closes #1247 Improve text "What is NCA?" #1248
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
jimrothstein
wants to merge
12
commits into
main
Choose a base branch
from
1247_improve_text_What_is_NCA
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
febda22
Test - first proposed change
jimrothstein 94c2a9a
Add inst/suggestions.md, temporary file for discussion
jimrothstein 03d5ae0
updates to suggestions.md, add to .gitignore (temporarily)
jimrothstein 75a9ac4
Merge branch 'main' into 1247_improve_text_What_is_NCA
jimrothstein aea7f31
revised
jimrothstein a0a6977
run document()
jimrothstein 0548b99
run document()
jimrothstein 4c7914c
Merge branch 'main' into 1247_improve_text_What_is_NCA
jimrothstein 87ce52e
Add /.quarto/ to .gitignore
jimrothstein 77c4f76
Add suggestions to background.Rmd
jimrothstein 5a17a82
remove inst/suggestions.md; other fixes
jimrothstein eb5d1d1
Merge branch 'main' into 1247_improve_text_What_is_NCA
jimrothstein File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: "suggestions.md to improve background.md " | ||
| format: html | ||
| --- | ||
|
|
||
| as of 25 APR 2026 | ||
|
|
||
| DRAFT | ||
|
|
||
| ## Vignettes | ||
|
|
||
| * background.Rmd (https://github.com/pharmaverse/aNCA/blob/main/vignettes/background.Rmd) | ||
| * manual.Rmd (https://github.com/pharmaverse/aNCA/blob/main/vignettes/manual.Rmd) | ||
|
|
||
|
|
||
| ## Contents | ||
|
|
||
| * Objective | ||
| * Audience? | ||
| * Set goals | ||
|
|
||
| ## OBJECTIVE | ||
| The goal is improve the document "What is NCA?" (background.md). Other than a few minor suggestions, I think document is already very good. | ||
|
|
||
| However, there is a fairly large gap between "What is NCA?" and the next | ||
| vignette, "Manual" . So I want to suggest supplementing "What is NCA?" or | ||
| adding a new document before manual.Rmd | ||
|
|
||
| In particular, I would include: | ||
|
|
||
| * few videos, to introducing NCA and introduce the implementation with PKNCA and aNCA packages | ||
| * Appilson, 5/29/25, (https://www.youtube.com/watch?v=hvVS80I6s_U) (reduce playback speed to 0.8 if accents are new to you) | ||
| * Basic pharmakinetics 1 Paths of drug through body (https://www.youtube.com/watch?v=WCmFrheYtcc ) | ||
| * Basic pharmakinetics 2 - How choice of route affects NCA parameters https://www.youtube.com/watch?v=WCmFrheYtcc | ||
| * a diagram or two to illustrate the flow of data | ||
| * input -> create objects -> run calculations | ||
| * video (2016) - Bill P introduces PKNCA package & process (https://www.youtube.com/watch?v=WCmFrheYtcc) | ||
| * PKNCA architecture https://github.com/humanpred/pknca/blob/ee1b433a0efcf102f4ec5260a1e3b39803ba26b2/design/01-architecture.md | ||
|
|
||
| * introduce some of subleties NCA must accommodate : | ||
| * possible time measurements, | ||
| * possible NCA parmaters, exclusions... | ||
| * where to find all the allowable variables and meaning (CDISC document) | ||
|
|
||
| ## AUDIENCE? | ||
|
|
||
| Is this document for: | ||
|
|
||
| * a new developer? | ||
| * a new user of the package **aNCA** ? | ||
|
|
||
| What assumptions should we make about the reader? | ||
|
|
||
| * Knows R? | ||
| * Knows NCA? | ||
| * Knows CDISC? | ||
|
|
||
| I would like to write so useful to someone like me. Familar with R, but new to pharmacokinetics (PK) , CDISC standards and the functions of aNCA package. This person wants to contribute to the codebase, ie a new developer. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.