{
  "_id": "6a1be1701d7bb097a0a1881c",
  "Package": "pipeFrame",
  "Type": "Package",
  "Title": "Pipeline framework for bioinformatics in R",
  "Version": "1.29.0",
  "Author": "Zheng Wei, Shining Ma",
  "Maintainer": "Zheng Wei <wzweizheng@qq.com>",
  "Description": "pipeFrame is an R package for building a componentized\nbioinformatics pipeline. Each step in this pipeline is wrapped\nin the framework, so the connection among steps is created\nseamlessly and automatically. Users could focus more on\nfine-tuning arguments rather than spending a lot of time on\ntransforming file format, passing task outputs to task inputs\nor installing the dependencies. Componentized step elements can\nbe customized into other new pipelines flexibly as well. This\npipeline can be split into several important functional steps,\nso it is much easier for users to understand the complex\narguments from each step rather than parameter combination from\nthe whole pipeline. At the same time, componentized pipeline\ncan restart at the breakpoint and avoid rerunning the whole\npipeline, which may save a lot of time for users on pipeline\ntuning or such issues as power off or process other interrupts.",
  "License": "GPL-3",
  "Encoding": "UTF-8",
  "RoxygenNote": "7.0.2",
  "VignetteBuilder": "knitr",
  "biocViews": "Software, Infrastructure, WorkflowStep",
  "URL": "https://github.com/wzthu/pipeFrame",
  "BugReports": "https://github.com/wzthu/pipeFrame/issues",
  "Config/pak/sysreqs": "cmake make libbz2-dev liblzma-dev libuv1-dev\nlibxml2-dev libssl-dev xz-utils zlib1g-dev",
  "Repository": "https://bioc.r-universe.dev",
  "Date/Publication": "2026-04-28 12:50:08 UTC",
  "RemoteUrl": "https://github.com/bioc/pipeFrame",
  "RemoteRef": "HEAD",
  "RemoteSha": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
  "NeedsCompilation": "no",
  "Packaged": {
    "Date": "2026-05-31 06:29:53 UTC",
    "User": "root"
  },
  "MD5sum": "3b6d9f2af794b61af329d14a58f76333",
  "_user": "bioc",
  "_type": "src",
  "_file": "pipeFrame_1.29.0.tar.gz",
  "_fileid": "19597284e625cb676576a62e560d2b1cfecf16a756821426538ebf0dfe24e606",
  "_filesize": 919352,
  "_sha256": "19597284e625cb676576a62e560d2b1cfecf16a756821426538ebf0dfe24e606",
  "_created": "2026-05-31T06:29:53.000Z",
  "_published": "2026-05-31T07:21:20.210Z",
  "_jobs": [
    {
      "job": 78705663768,
      "time": 240,
      "config": "bioc-checks",
      "r": "4.6.0",
      "check": "ERROR",
      "artifact": "7314463303"
    },
    {
      "job": 78705663776,
      "time": 456,
      "config": "linux-devel-x86_64",
      "r": "4.7.0",
      "check": "NOTE",
      "artifact": "7314488345"
    },
    {
      "job": 78705663769,
      "time": 507,
      "config": "linux-release-x86_64",
      "r": "4.6.0",
      "check": "NOTE",
      "artifact": "7314494170"
    },
    {
      "job": 78705663778,
      "time": 255,
      "config": "macos-oldrel-arm64",
      "r": "4.5.3",
      "check": "NOTE",
      "artifact": "7314756505"
    },
    {
      "job": 78705663770,
      "time": 237,
      "config": "macos-release-arm64",
      "r": "4.6.0",
      "check": "NOTE",
      "artifact": "7314746189"
    },
    {
      "job": 78705251939,
      "time": 453,
      "config": "source",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7314436415"
    },
    {
      "job": 78705663764,
      "time": 210,
      "config": "wasm-release",
      "r": "4.6.0",
      "check": "OK",
      "artifact": "7314460101"
    },
    {
      "job": 78705663789,
      "time": 332,
      "config": "windows-devel",
      "r": "4.7.0",
      "check": "NOTE",
      "artifact": "7314474117"
    },
    {
      "job": 78705663851,
      "time": 346,
      "config": "windows-oldrel",
      "r": "4.5.3",
      "check": "NOTE",
      "artifact": "7314475716"
    },
    {
      "job": 78705663784,
      "time": 292,
      "config": "windows-release",
      "r": "4.6.0",
      "check": "NOTE",
      "artifact": "7314469286"
    }
  ],
  "_bioccheck": {
    "error": 3,
    "warning": 1,
    "note": 9
  },
  "_buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449",
  "_status": "success",
  "_host": "GitHub-Actions",
  "_upstream": "https://github.com/bioc/pipeFrame",
  "_commit": {
    "id": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
    "author": "A Wokaty <andres.wokaty@sph.cuny.edu>",
    "committer": "A Wokaty <andres.wokaty@sph.cuny.edu>",
    "message": "bump x.y.z version to odd y following creation of RELEASE_3_23 branch\n",
    "time": 1777380608
  },
  "_maintainer": {
    "name": "Zheng Wei",
    "email": "wzweizheng@qq.com",
    "login": "wzthu",
    "description": "eXplainable AI (XAI) |\ndeep learning |\ngenomics |\ncomputational biology |\nbioinformatics ",
    "uuid": 19941845
  },
  "_distro": "noble",
  "_registered": true,
  "_dependencies": [
    {
      "package": "R",
      "version": ">= 4.0.0",
      "role": "Depends"
    },
    {
      "package": "BSgenome",
      "role": "Imports"
    },
    {
      "package": "digest",
      "role": "Imports"
    },
    {
      "package": "visNetwork",
      "role": "Imports"
    },
    {
      "package": "magrittr",
      "role": "Imports"
    },
    {
      "package": "methods",
      "role": "Imports"
    },
    {
      "package": "Biostrings",
      "role": "Imports"
    },
    {
      "package": "Seqinfo",
      "role": "Imports"
    },
    {
      "package": "parallel",
      "role": "Imports"
    },
    {
      "package": "stats",
      "role": "Imports"
    },
    {
      "package": "utils",
      "role": "Imports"
    },
    {
      "package": "rmarkdown",
      "role": "Imports"
    },
    {
      "package": "BiocManager",
      "role": "Suggests"
    },
    {
      "package": "knitr",
      "role": "Suggests"
    },
    {
      "package": "rtracklayer",
      "role": "Suggests"
    },
    {
      "package": "testthat",
      "role": "Suggests"
    },
    {
      "package": "BSgenome.Hsapiens.UCSC.hg19",
      "role": "Suggests"
    }
  ],
  "_owner": "bioc",
  "_selfowned": true,
  "_usedby": 1,
  "_updates": [
    {
      "week": "2025-30",
      "n": 1
    },
    {
      "week": "2025-44",
      "n": 2
    },
    {
      "week": "2026-18",
      "n": 2
    }
  ],
  "_tags": [],
  "_bioc": [
    {
      "branch": "devel",
      "version": "1.29.0",
      "bioc": "3.24"
    },
    {
      "branch": "release",
      "version": "1.28.0",
      "bioc": "3.23"
    }
  ],
  "_topics": [
    "software",
    "infrastructure",
    "workflowstep"
  ],
  "_stars": 1,
  "_contributors": [
    {
      "user": "wzthu",
      "count": 223,
      "uuid": 19941845
    },
    {
      "user": "snmastanford",
      "count": 17,
      "uuid": 48105506
    },
    {
      "user": "nturaga",
      "count": 10,
      "uuid": 2746443
    }
  ],
  "_userbio": {
    "uuid": 2286807,
    "type": "organization",
    "name": "Bioconductor",
    "description": "Software for the analysis and comprehension of high-throughput genomic data"
  },
  "_downloads": {
    "count": 442,
    "source": "https://www.bioconductor.org/packages/stats/bioc/pipeFrame"
  },
  "_devurl": "https://github.com/wzthu/pipeframe",
  "_searchresults": 2,
  "_rbuild": "4.6.0",
  "_assets": [
    "extra/citation.cff",
    "extra/citation.html",
    "extra/citation.json",
    "extra/citation.txt",
    "extra/contents.json",
    "extra/NEWS.html",
    "extra/NEWS.txt",
    "extra/pipeFrame.html",
    "manual.pdf"
  ],
  "_homeurl": "https://github.com/wzthu/pipeframe",
  "_realowner": "bioc",
  "_cranurl": false,
  "_exports": [
    "addEdges",
    "addFileSuffix",
    "argv",
    "checkAllPath",
    "checkAndInstallBSgenome",
    "checkAndInstallGenomeFa",
    "checkAndInstallOrgDb",
    "checkAndInstallTxDb",
    "checkFileCreatable",
    "checkFileExist",
    "checkPathExist",
    "checkRequireParam",
    "clearStepCache",
    "configRegName",
    "genReport",
    "getAttachedStep",
    "getAutoPath",
    "getBasenamePrefix",
    "getGenome",
    "getJobDir",
    "getJobName",
    "getNextSteps",
    "getObjsInPipe",
    "getParam",
    "getParamItems",
    "getParamMD5Path",
    "getPathPrefix",
    "getPipeName",
    "getPrevSteps",
    "getRef",
    "getRefDir",
    "getRefFiles",
    "getRefRc",
    "getStepWorkDir",
    "getThreads",
    "getTmpDir",
    "getValidGenome",
    "ignoreCheck",
    "init",
    "initPipeFrame",
    "input",
    "input<-",
    "isReady",
    "loadConfig",
    "loadStep",
    "output",
    "output<-",
    "param",
    "param<-",
    "pipeName",
    "printMap",
    "processing",
    "property",
    "property<-",
    "regAttachedStep",
    "report",
    "report<-",
    "runWithFinishCheck",
    "saveConfig",
    "setGenome",
    "setJobName",
    "setPipeName",
    "setRefDir",
    "setThreads",
    "setTmpDir",
    "Step",
    "stepID",
    "stepName",
    "stepType",
    "writeLog"
  ],
  "_help": [
    {
      "page": "getObjsInPipe",
      "title": "Obtain all of objects in the specific pipeline",
      "topics": [
        "getObjsInPipe"
      ]
    },
    {
      "page": "graphMng",
      "title": "Step graph management",
      "topics": [
        "addEdges",
        "getAttachedStep",
        "getNextSteps",
        "getPrevSteps",
        "graphMng",
        "printMap",
        "regAttachedStep"
      ]
    },
    {
      "page": "ignoreCheck",
      "title": "ignore checking input and output file (for developer)",
      "topics": [
        "ignoreCheck"
      ]
    },
    {
      "page": "initPipeFrame",
      "title": "initialize the pipeFrame package",
      "topics": [
        "initPipeFrame"
      ]
    },
    {
      "page": "loadConfig",
      "title": "load configure from file",
      "topics": [
        "configRegName",
        "loadConfig",
        "saveConfig"
      ]
    },
    {
      "page": "loadStep",
      "title": "load step object from rds file",
      "topics": [
        "loadStep"
      ]
    },
    {
      "page": "runWithFinishCheck",
      "title": "Install dependent data or software with finishing check",
      "topics": [
        "checkAndInstallBSgenome",
        "checkAndInstallGenomeFa",
        "checkAndInstallOrgDb",
        "checkAndInstallTxDb",
        "runWithFinishCheck"
      ]
    },
    {
      "page": "setGenome",
      "title": "Configure genome for all steps",
      "topics": [
        "getGenome",
        "getValidGenome",
        "setGenome"
      ]
    },
    {
      "page": "setJobName",
      "title": "Configure the job name for following steps.",
      "topics": [
        "getJobDir",
        "getJobName",
        "setJobName"
      ]
    },
    {
      "page": "setPipeName",
      "title": "Configure the pipe name for following steps.",
      "topics": [
        "getPipeName",
        "setPipeName"
      ]
    },
    {
      "page": "setRefDir",
      "title": "Set the reference directory",
      "topics": [
        "getRef",
        "getRefDir",
        "getRefFiles",
        "getRefRc",
        "setRefDir"
      ]
    },
    {
      "page": "setThreads",
      "title": "Configure the maximum number of threads",
      "topics": [
        "getThreads",
        "setThreads"
      ]
    },
    {
      "page": "setTmpDir",
      "title": "Configure the directory for intermediate results of all steps",
      "topics": [
        "getTmpDir",
        "setTmpDir"
      ]
    },
    {
      "page": "Step-class",
      "title": "Methods for Step objects",
      "topics": [
        "$",
        "$,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"
      ]
    },
    {
      "page": "Utils",
      "title": "Functions for directory operations",
      "topics": [
        "addFileSuffix",
        "checkFileCreatable",
        "checkFileExist",
        "checkPathExist",
        "getBasenamePrefix",
        "getPathPrefix",
        "Utils"
      ]
    }
  ],
  "_rundeps": [
    "abind",
    "askpass",
    "base64enc",
    "BH",
    "Biobase",
    "BiocBaseUtils",
    "BiocGenerics",
    "BiocIO",
    "BiocParallel",
    "Biostrings",
    "bitops",
    "BSgenome",
    "bslib",
    "cachem",
    "cigarillo",
    "cli",
    "codetools",
    "cpp11",
    "crayon",
    "curl",
    "DelayedArray",
    "digest",
    "evaluate",
    "fastmap",
    "fontawesome",
    "formatR",
    "fs",
    "futile.logger",
    "futile.options",
    "generics",
    "GenomicAlignments",
    "GenomicRanges",
    "highr",
    "htmltools",
    "htmlwidgets",
    "httr",
    "IRanges",
    "jquerylib",
    "jsonlite",
    "knitr",
    "lambda.r",
    "lattice",
    "lifecycle",
    "magrittr",
    "Matrix",
    "MatrixGenerics",
    "matrixStats",
    "memoise",
    "mime",
    "openssl",
    "R6",
    "rappdirs",
    "RCurl",
    "restfulr",
    "Rhtslib",
    "rjson",
    "rlang",
    "rmarkdown",
    "Rsamtools",
    "rtracklayer",
    "S4Arrays",
    "S4Vectors",
    "sass",
    "Seqinfo",
    "snow",
    "SparseArray",
    "SummarizedExperiment",
    "sys",
    "tinytex",
    "visNetwork",
    "xfun",
    "XML",
    "XVector",
    "yaml"
  ],
  "_vignettes": [
    {
      "source": "pipeFrame.Rmd",
      "filename": "pipeFrame.html",
      "title": "Componentized Pipeline Framework",
      "author": "Zheng Wei and Shining Ma",
      "engine": "knitr::rmarkdown",
      "headings": [
        "What is pipeFrame",
        "Download and Installation",
        "Building the pipeline",
        "Initialize",
        "Configuration",
        "Temporary Directory",
        "Reference Directory",
        "Genome Annotation",
        "Reference Data Generation",
        "Threads",
        "Job Name",
        "Step Restriction and Graph Management",
        "Step Componentization",
        "Non-object Function Wrapper",
        "Class Implementation",
        "Step Components Usage",
        "Combine into Whole Pipeline",
        "Session Information"
      ],
      "created": "2019-04-17 06:50:36",
      "modified": "2019-12-16 12:58:12",
      "commits": 9
    }
  ],
  "_score": 4.2552725051033065,
  "_indexed": true,
  "_nocasepkg": "pipeframe",
  "_universes": [
    "bioc",
    "wzthu"
  ],
  "_binaries": [
    {
      "r": "4.7.0",
      "os": "linux",
      "version": "1.29.0",
      "date": "2026-05-31T06:35:08.000Z",
      "distro": "noble",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "ef66bb23abb94eaba5fc14acaf65a69384e7d328c96030aaaed5ec14a79b5e65",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.6.0",
      "os": "linux",
      "version": "1.29.0",
      "date": "2026-05-31T06:36:00.000Z",
      "distro": "noble",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "8e67a5078b5720106cfc510ae9328d5cc9725fb97011fea1f01879872debdf97",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.5.3",
      "os": "mac",
      "version": "1.29.0",
      "date": "2026-05-31T07:18:51.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "755ce4104f1e2c95893281bb58db58a96e647a7c3a08731d140123ef2d8ad19d",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.6.0",
      "os": "mac",
      "version": "1.29.0",
      "date": "2026-05-31T07:17:33.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "43e964bd3d53f7a273469b3526c453c09eea2d066a1ee966362cf9dcbbf6dc04",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.6.0",
      "os": "wasm",
      "version": "1.29.0",
      "date": "2026-05-31T06:34:07.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "80d97e5306f61e04aea8aeff5cbff6ebe607d5331c9806ee9bf5b7ff4696e72e",
      "status": "success",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.7.0",
      "os": "win",
      "version": "1.29.0",
      "date": "2026-05-31T06:33:03.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "9619375ea8842ee0c9da4e0cc37eb496a4cbb7b49981598c5bffa9748300e263",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.5.3",
      "os": "win",
      "version": "1.29.0",
      "date": "2026-05-31T06:33:40.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "ccdf4431cc99ea51fdfccb7c45ebb084b9848aa96b7f59547ccc072e1ea9b790",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    },
    {
      "r": "4.6.0",
      "os": "win",
      "version": "1.29.0",
      "date": "2026-05-31T06:32:40.000Z",
      "commit": "48fcd30eeb8142f55a104c4614ab3d48a08a8e75",
      "fileid": "0be4d4d80e1647db49269238d557b9e1f0a1e80c723fe2752a3b1c4292aa7a29",
      "status": "success",
      "check": "NOTE",
      "buildurl": "https://github.com/r-universe/bioc/actions/runs/26705274449"
    }
  ]
}