Skip to content
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

Add pre-processing vignette, new preProcessAdat() function #134

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

scheidec
Copy link
Contributor

@scheidec scheidec commented Oct 7, 2024

Pre-Processing and Documentation Updates

  • added pre-processing vignette article walking through default recommended steps for pre-processing an ADAT file prior to analysis
    • includes sections on filtering features, filtering samples, data QC and transformations
  • added calcOutlierMap() and its print and plot S3 methods from SomaPlotr package, along with getFlaggedIds() for identifying sample level outliers
  • added preProcessAdat() function which performs steps outlined in vignette, also now used in stat workflow articles
  • improved adat ingest documentation in README and stat workflow articles, detailing how a file path to an ADAT stored on a local filesystem would be defined
  • added helper utility functions for saving snapshot plot output to testthat/helper.R for preProcessAdat() unit tests

- added pre-processing.Rmd to vignettes/articles/
  with outline of topics to include
- added entry to _pkgdown.yml
- drafted sections on filtering features,
  filtering samples, data qc and transformations
- added `calcOutlierMap()` and its print and plot
  S3 methods, along with `getFlaggedIds()` for
  identifying sample level outliers
- added new function `preProcessAdat()`
  to filter features, filter samples,
  generate data qc plots, and perform
  standard analyte RFU transformations
- added comments to clarify filepath input
  to `read_adat()` example in README
- updated stat workflow articles with
  comments about how to read in the
  `example_data.adat` object
- updated data preparation chunks to
  use the `preProcessAdat()` function
  for filtering features, filtering samples,
  data qc plots for covariate, and log10,
  center and scale transformations
- added snapshot unit tests for preProcessAdat()
  messaging, print and qc plot output
- added helper utility functions for saving plot
  snapshot output to testthat/helper.R
@scheidec scheidec requested a review from alexatSL October 7, 2024 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant