https://github.com/gagneurlab/wbuild
R project report builder
https://github.com/gagneurlab/wbuild
bioinformatics snakemake wbuild
Last synced: about 1 month ago
JSON representation
R project report builder
- Host: GitHub
- URL: https://github.com/gagneurlab/wbuild
- Owner: gagneurlab
- Created: 2018-06-25T09:27:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2025-02-26T10:56:00.000Z (3 months ago)
- Last Synced: 2025-04-09T20:17:03.051Z (about 1 month ago)
- Topics: bioinformatics, snakemake, wbuild
- Language: Python
- Homepage: https://wbuild.readthedocs.io/en/latest/
- Size: 702 KB
- Stars: 4
- Watchers: 4
- Forks: 6
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- Authors: AUTHORS.rst
Awesome Lists containing this project
README
# wBuild
Automatic build tool for R Reports
## Documentation
Full documentation is available at https://wbuild.readthedocs.io
## Features
* Supports reproducible research
* Append R-markdown scripts to the Snakemake pipeline
* Render the R scripts to a structured web page
* Snakemake rules written directly in the header of scripts
* Dependencies updated automatically!
## Installation
Install using pip:
- `pip install wBuild`
See "Installation" tab in the documentation for more details.
## Getting started
* Navigate to an empty directory
* Run `wbuild demo`. This will create a wBuild demo project with various examples
* Explore the files in `Scripts/`
* Run `snakemake` to build the project
* Open `Output/html/index.html` in your web browser
* There you will find useful and understandable examples of features and operations with wBuild
## Usage
* Navigate to the root of your project (new or existing)
* Run `wbuild init`
* Run `snakemake`
## GitHub
wBuild is an open-source software. The source-code is available at https://github.com/gagneurlab/wBuild.
## Credits
Leonhard Wachutka