Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,6 @@ biocViews: GenomeAssembly, Annotation, Sequencing
VignetteBuilder: knitr
Suggests:
rmarkdown,
writexl,
testthat (>= 3.0.0)
Config/roxygen2/version: 8.0.0
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ export(CDHIT2duckdb)
export(buildClusterFeatureMap)
export(cleanData)
export(cleanMetaData)
export(exportProcessedData)
export(generatePlots)
export(generateSummary)
export(prepareGenomes)
Expand Down
298 changes: 247 additions & 51 deletions R/data_curation.R

Large diffs are not rendered by default.

424 changes: 410 additions & 14 deletions R/data_processing.R

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ Processing times vary by species and isolate count:
- These numbers will all vary greatly based on isolate number, genome complexity, and available hardware.
- Parallelization significantly reduces processing time when multiple cores are available.
- If a `future::multisession` error occurs mid-run (e.g. while testing via `devtools::load_all()` before installing the package), restart your R session fully before retrying. An orphaned background worker process can leave a stale lock on the local DuckDB caches (e.g. `data/bvbrc/bvbrcData.duckdb`), which can produce inconsistent results on the next run that look like a data or QC bug but are actually just leftover session state.
- If a `furrr`/`future::multisession` worker fails with `could not find function ".xxx"` for an internal amRdata helper, your installed copy of amRdata is stale relative to the source you're editing. `future::multisession` workers are fresh R processes that resolve `amRdata` by loading the *installed* package from `.libPaths()` — they do not see changes made only via `devtools::load_all()` in your interactive session. Run `devtools::install()` (or `pkgbuild::compile_dll(); devtools::document(); devtools::install()`) before exercising any function that runs work via `future`/`furrr`, or temporarily set `future::plan(future::sequential)` while iterating with `load_all()` alone.
- `runDataProcessing()`/`runPanaroo2Duckdb()` default `panaroo_refind_mode` to `"off"` rather than Panaroo's own default. Refinding recovers gene calls that annotation tools missed, but its search can take substantially longer (or in rare cases fail to complete within hours) when a genome carries a cluster of CDS with internal stop codons — a condition existing genome-quality metadata (CheckM completeness/contamination, consistency scores, quality flags) does not flag. This default trades some gene-recovery accuracy for predictable runtime until a QC step upstream can screen out affected genomes; set `panaroo_refind_mode = "default"` to restore Panaroo's normal behavior.

### Integration with amR suite

Expand Down
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,30 @@ Processing times vary by species and isolate count:
results on the next run that look like a data or QC bug but are
actually just leftover session state.

- If a `furrr`/`future::multisession` worker fails with
`could not find function ".xxx"` for an internal amRdata helper,
your installed copy of amRdata is stale relative to the source
you're editing. `future::multisession` workers are fresh R
processes that resolve `amRdata` by loading the *installed* package
from `.libPaths()` — they do not see changes made only via
`devtools::load_all()` in your interactive session. Run
`devtools::install()` before exercising any function that runs work
via `future`/`furrr`, or temporarily set
`future::plan(future::sequential)` while iterating with `load_all()`
alone.

- `runDataProcessing()`/`runPanaroo2Duckdb()` default
`panaroo_refind_mode` to `"off"` rather than Panaroo's own default.
Refinding recovers gene calls that annotation tools missed, but its
search can take substantially longer (or in rare cases fail to
complete within hours) when a genome carries a cluster of CDS with
internal stop codons — a condition existing genome-quality metadata
(CheckM completeness/contamination, consistency scores, quality
flags) does not flag. This default trades some gene-recovery
accuracy for predictable runtime until a QC step upstream can screen
out affected genomes; set `panaroo_refind_mode = "default"` to
restore Panaroo's normal behavior.

### Integration with amR suite

amRdata is designed to work seamlessly with other amR packages:
Expand Down
Binary file added inst/extdata/Campy_testdata.zip
Binary file not shown.
49 changes: 49 additions & 0 deletions man/dot-apply_metadata_qc.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 0 additions & 22 deletions man/dot-ftpes_download_two_pass.Rd

This file was deleted.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions man/dot-ftps_download_two_pass.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions man/dot-parse_bvbrc_tsv.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion man/dot-processPanaroo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 6 additions & 1 deletion man/dot-runPanaroo.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

43 changes: 43 additions & 0 deletions man/exportProcessedData.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 44 additions & 0 deletions man/exportTables.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/genomeList.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 25 additions & 1 deletion man/prepareGenomes.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading