Package: pipeFrame 1.23.0

Zheng Wei

pipeFrame: Pipeline framework for bioinformatics in R

pipeFrame is an R package for building a componentized bioinformatics pipeline. Each step in this pipeline is wrapped in the framework, so the connection among steps is created seamlessly and automatically. Users could focus more on fine-tuning arguments rather than spending a lot of time on transforming file format, passing task outputs to task inputs or installing the dependencies. Componentized step elements can be customized into other new pipelines flexibly as well. This pipeline can be split into several important functional steps, so it is much easier for users to understand the complex arguments from each step rather than parameter combination from the whole pipeline. At the same time, componentized pipeline can restart at the breakpoint and avoid rerunning the whole pipeline, which may save a lot of time for users on pipeline tuning or such issues as power off or process other interrupts.

Authors:Zheng Wei, Shining Ma

pipeFrame_1.23.0.tar.gz
pipeFrame_1.23.0.zip(r-4.5)pipeFrame_1.23.0.zip(r-4.4)pipeFrame_1.23.0.zip(r-4.3)
pipeFrame_1.23.0.tgz(r-4.4-any)pipeFrame_1.23.0.tgz(r-4.3-any)
pipeFrame_1.23.0.tar.gz(r-4.5-noble)pipeFrame_1.23.0.tar.gz(r-4.4-noble)
pipeFrame_1.23.0.tgz(r-4.4-emscripten)pipeFrame_1.23.0.tgz(r-4.3-emscripten)
pipeFrame.pdf |pipeFrame.html
pipeFrame/json (API)
NEWS

# Install 'pipeFrame' in R:
install.packages('pipeFrame', repos = c('https://bioc.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/wzthu/pipeframe/issues

On BioConductor:pipeFrame-1.21.0(bioc 3.21)pipeFrame-1.22.0(bioc 3.20)

softwareinfrastructureworkflowstep

4.08 score 1 stars 1 packages 2 scripts 252 downloads 70 exports 75 dependencies

Last updated 23 days agofrom:f9587ae8ea. Checks:OK: 1 NOTE: 6. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 31 2024
R-4.5-winNOTEOct 31 2024
R-4.5-linuxNOTEOct 31 2024
R-4.4-winNOTEOct 31 2024
R-4.4-macNOTEOct 31 2024
R-4.3-winNOTEOct 31 2024
R-4.3-macNOTEOct 31 2024

Exports:addEdgesaddFileSuffixargvcheckAllPathcheckAndInstallBSgenomecheckAndInstallGenomeFacheckAndInstallOrgDbcheckAndInstallTxDbcheckFileCreatablecheckFileExistcheckPathExistcheckRequireParamclearStepCacheconfigRegNamegenReportgetAttachedStepgetAutoPathgetBasenamePrefixgetGenomegetJobDirgetJobNamegetNextStepsgetObjsInPipegetParamgetParamItemsgetParamMD5PathgetPathPrefixgetPipeNamegetPrevStepsgetRefgetRefDirgetRefFilesgetRefRcgetStepWorkDirgetThreadsgetTmpDirgetValidGenomeignoreCheckinitinitPipeFrameinputinput<-isReadyloadConfigloadStepoutputoutput<-paramparam<-pipeNameprintMapprocessingpropertyproperty<-regAttachedStepreportreport<-runWithFinishChecksaveConfigsetGenomesetJobNamesetPipeNamesetRefDirsetThreadssetTmpDirStepstepIDstepNamestepTypewriteLog

Dependencies:abindaskpassbase64encBHBiobaseBiocGenericsBiocIOBiocParallelBiostringsbitopsBSgenomebslibcachemclicodetoolscpp11crayoncurlDelayedArraydigestevaluatefastmapfontawesomeformatRfsfutile.loggerfutile.optionsGenomeInfoDbGenomeInfoDbDataGenomicAlignmentsGenomicRangesgluehighrhtmltoolshtmlwidgetshttrIRangesjquerylibjsonliteknitrlambda.rlatticelifecyclemagrittrMatrixMatrixGenericsmatrixStatsmemoisemimeopensslR6rappdirsRCurlrestfulrRhtslibrjsonrlangrmarkdownRsamtoolsrtracklayerS4ArraysS4VectorssasssnowSparseArraySummarizedExperimentsystinytexUCSC.utilsvisNetworkxfunXMLXVectoryamlzlibbioc

Componentized Pipeline Framework

Rendered frompipeFrame.Rmdusingknitr::rmarkdownon Oct 31 2024.

Last update: 2019-12-16
Started: 2019-04-17

Readme and manuals

Help Manual

Help pageTopics
Obtain all of objects in the specific pipelinegetObjsInPipe
Step graph managementaddEdges getAttachedStep getNextSteps getPrevSteps graphMng printMap regAttachedStep
ignore checking input and output file (for developer)ignoreCheck
initialize the pipeFrame packageinitPipeFrame
load configure from fileconfigRegName loadConfig saveConfig
load step object from rds fileloadStep
Install dependent data or software with finishing checkcheckAndInstallBSgenome checkAndInstallGenomeFa checkAndInstallOrgDb checkAndInstallTxDb runWithFinishCheck
Configure genome for all stepsgetGenome getValidGenome setGenome
Configure the job name for following steps.getJobDir getJobName setJobName
Configure the pipe name for following steps.getPipeName setPipeName
Set the reference directorygetRef getRefDir getRefFiles getRefRc setRefDir
Configure the maximum number of threadsgetThreads setThreads
Configure the directory for intermediate results of all stepsgetTmpDir setTmpDir
Methods for Step objects$ $,Step-method $<- $<-,Step-method argv argv,Step-method checkAllPath checkAllPath,Step-method checkRequireParam checkRequireParam,Step-method clearStepCache clearStepCache,Step-method genReport getAutoPath getAutoPath,Step-method getParam getParam,Step-method getParamItems getParamItems,Step-method getParamMD5Path getParamMD5Path,Step-method getStepWorkDir getStepWorkDir,Step-method init init,Step-method input input,Step-method input<- input<-,Step-method isReady isReady,Step-method output output,Step-method output<- output<-,Step-method param param,Step-method param<- param<-,Step-method pipeName pipeName,Step-method processing property property,Step-method property<- property<-,Step-method report report,Step-method report<- report<-,Step-method Step Step-class stepID stepID,Step-method stepName stepName,Step-method stepType stepType,Step-method writeLog writeLog,Step-method
Functions for directory operationsaddFileSuffix checkFileCreatable checkFileExist checkPathExist getBasenamePrefix getPathPrefix Utils