README.md

In ParallelLogger: Support for Parallel Computation, Logging, and Function Automation

ParallelLogger

ParallelLogger is part of HADES.

Introduction

Support for parallel computation with progress bar, and option to stop or proceed on errors. Also provides logging to console and disk, and the logging persists in the parallel threads. Additional functions support function call automation with delayed execution (e.g. for executing functions in parallel).

Features

• Functions for parallel computation.
• Functions for logging, including automated logging for errors and warnings.
• Functions used for automating analyses.

Examples

# Run a function in parallel:
fun <- function(x) {
  return (x^2)
}

cluster <- makeCluster(numberOfThreads = 3)
result <- clusterApply(cluster, 1:10, fun)
stopCluster(cluster)

# Create a file logger:
addDefaultFileLogger("log.txt")
logTrace("Hello world")

Technology

ParallelLogger is an R package.

System Requirements

Requires R (version 4.0.0 or higher)

Getting Started

In R, to install the latest stable version, install from CRAN:

install.packages("ParallelLogger")

To install the latest development version, install from the develop branch in GitHub:

install.packages("remotes")
library(remotes)
install_github("ohdsi/ParallelLogger", ref = "develop")

User Documentation

Documentation can be found on the package website.

PDF versions of the documentation is also available: Vignette: Logging using ParallelLogger Vignette: Parallel execution using ParallelLogger * Package manual: ParallelLogger.pdf

Contributing

Read here how you can contribute to this package.

Support

• Developer questions/comments/feedback: OHDSI Forum
• We use the GitHub issue tracker for all bugs/issues/enhancements

Contributing

Read here how you can contribute to this package.

License

ParallelLogger is licensed under Apache License 2.0

Development

ParallelLogger is being developed in R Studio.

Development status

Ready for use

Acknowledgements

• This project is supported in part through the National Science Foundation grant IIS 1251151.

ParallelLogger documentation built on Sept. 11, 2024, 8:52 p.m.