Conversation
jeffreyad
requested review from
Fanny-Gautier,
bms63,
orladoylenvs and
rossfarrugia
Fanny-Gautier
left a comment
Fanny-Gautier
left a comment
There was a problem hiding this comment.
Minor comment to implement. LGTM!
| ## Getting Started | ||
|
|
||
| The examples are organized by the stage of the clinical data pipeline they cover. | ||
| If you're new to pharmaverse, working through them in order gives a natural end-to-end |
There was a problem hiding this comment.
| If you're new to pharmaverse, working through them in order gives a natural end-to-end | |
| If you're new to `pharmaverse`, working through them in order gives a natural end-to-end |
|
Can you add some more column width so the curlies stay on the same line? |
rossfarrugia
left a comment
rossfarrugia
left a comment
There was a problem hiding this comment.
Thanks Jeff - some comments for consideration
| [Launch Posit Cloud](https://posit.cloud/content/7279124) to run any example | ||
| interactively without a local R installation. Open **File → Open File** and | ||
| choose whichever example script you'd like to explore. | ||
| ::: |
There was a problem hiding this comment.
Some notes have been removed here which i think could be useful:
- the fact the workspace is preconfigured with all required package installations, so users don't need to install packages themselves
- Guidance of how exactly to find the files, e.g. and then choosing whichever example script, e.g. adam/adsl.R
- the note at the end: Feel free to try out customizing any of the examples to better fit any of your own internal clinical reporting workflows!
| Note that this examples book should only be used to show how collections of | ||
| packages can be used in conjunction - more thorough examples of individual | ||
| package usages would always be covered in the package site vignettes and no | ||
| need to repeat here. |
There was a problem hiding this comment.
Might this paragraph still be a useful guardrail? Maybe its more for contributors at the bottom though?
| | Section | What it covers | Good starting point if… | | ||
| |---------|---------------|--------------------------| | ||
| | **[SDTM](sdtm/index.qmd)** | Converting raw collected data to CDISC SDTM domains | You work upstream of ADaM or want to understand the data origin | | ||
| | **[ADaM](adam/index.qmd)** | Building analysis datasets (ADSL, ADTTE, ADPC, etc.) from SDTM | You're implementing analysis-ready datasets for reporting | |
There was a problem hiding this comment.
Should we use the usual backticks around any dataset names, e.g. ADSL here?
|
|
||
| If you're primarily interested in a specific output type, jump directly to the | ||
| [TLG section](tlg/index.qmd), which is self-contained and uses pre-built ADaM | ||
| datasets from `{pharmaverseadam}`. |
There was a problem hiding this comment.
Not sure this paragraph adds anything?
| the part of the pipeline where it appears. Clicking a package name opens its | ||
| documentation; the Example column links to where it is used on this site. | ||
|
|
||
| ### Data Packages |
There was a problem hiding this comment.
You should add something to https://github.com/pharmaverse/examples/blob/main/.github/PULL_REQUEST_TEMPLATE.md to remind contributors to maintain this and the above sections for any future new articles / website sections added
There was a problem hiding this comment.
Also could include the new section landing pages here - as what you've added to the site is great, i just want to make sure it gets maintained
|
|
||
| You can see a list of current contributors via our GitHub repo DESCRIPTION file. | ||
| Have an example that others would benefit from? Contributions are welcome — see | ||
| the [GitHub repository](https://github.com/pharmaverse/examples) for guidance on |
There was a problem hiding this comment.
Point them to README file?
| without writing the code yourself, open an issue and the team will review it for | ||
| the backlog. | ||
|
|
||
| While you're there, consider giving the packages you use a |
There was a problem hiding this comment.
And this examples repo too?
4 participants
Pull Request
DESCRIPTION GOES HERE
Before you submit your pull request, take a look at the following checklist. Many thanks for your contribution!
Closes #<insert_issue_number>at the beginning of your PR title. Use the Edit button in the top-right if you need to update.DESCRIPTIONfile.DESCRIPTIONfile'sImportssection.