diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 847abc5..3aca9d7 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -9,13 +9,13 @@ jobs: release: runs-on: ubuntu-latest steps: - - name: Checkout + - name: Checkout # ---------------------------------------------------------------- uses: actions/checkout@v1 - - name: Set up Go 1.15 + - name: Set up Go 1.15 # ---------------------------------------------------------- uses: actions/setup-go@v1 with: go-version: 1.15.11 - - name: Build with xgo + - name: Build with xgo # ---------------------------------------------------------- uses: crazy-max/ghaction-xgo@v1 with: xgo_version: latest @@ -26,7 +26,7 @@ jobs: v: true x: false ldflags: -s -w - - name: Create Release + - name: Create Release # ---------------------------------------------------------- uses: actions/create-release@v1.0.0 id: create_release env: @@ -36,14 +36,14 @@ jobs: release_name: Release ${{ github.ref }} draft: false prerelease: false - - name: Upload Release Assets + - name: Upload Release Assets # --------------------------------------------------- uses: glentiki/xbin-release-action@v1.0.0 env: GITHUB_TOKEN: ${{ secrets.GO_RELEASE_TOKEN }} with: upload_url: ${{ steps.create_release.outputs.upload_url }} # This pulls from the CREATE RELEASE step above, referencing it's ID to get its outputs object, which include a `upload_url`. See this blog post for more info: https://jasonet.co/posts/new-features-of-github-actions/#passing-data-to-future-steps assets_path: ./build - - name: Publish conda + - name: Publish conda # ----------------------------------------------------------- uses: maxibor/conda-package-publish-action@v1.1 with: subDir: 'conda' diff --git a/README.md b/README.md index 5595a2b..0f8585c 100644 --- a/README.md +++ b/README.md @@ -2,31 +2,26 @@ # GoPeaks -GoPeaks is a peak caller designed for CUT&TAG/CUT&RUN sequencing data. GoPeaks by default works best with narrow peaks such as H3K4me3 and transcription factors. GoPeaks can be used with the "--broad" flag to call broad peaks like H3K27Ac/H3K4me1. We encourage users to explore the parameters of GoPeaks to analyze their data. +GoPeaks is a peak caller designed for CUT&TAG/CUT&RUN sequencing data. GoPeaks by default works best with narrow peaks such as H3K4me3 and transcription factors. However, broad epigenetic marks like H3K27Ac/H3K4me1 require different the step, slide, and minwidth parameters. We encourage users to explore the parameters of GoPeaks to analyze their data. -# Installation - -## Conda +## Configure Download the latest release using conda: ``` -$ conda install -c jakevc gopeaks +conda install -c jakevc gopeaks ``` -## GitHub - -Download the GoPeaks compiled binaries directly from GitHub: +Or download binary asset directly from github: -```bash -$ wget -O GoPeaks https://github.com/maxsonBraunLab/gopeaks/releases/download/1.0.0/gopeaks-linux-amd64 -$ chmod +x GoPeaks +``` +wget -O gopeaks https://github.com/maxsonBraunLab/gopeaks/releases/download/v1.0.0/gopeaks-linux-amd64 +chmod +x gopeaks ``` -# Example Usage +## Example Usage -```bash -$ ./GoPeaks -h +``` usage: GoPeaks [-h|--help] [-b|--bam ""] [-c|--control ""] [-s|--chromsize ""] [-m|--mdist ] [-r|--minreads ] [-p|--pval ] [-t|--step ] [-l|--slide @@ -62,19 +57,13 @@ Arguments: --broad Run GoPeaks on broad marks (--step 5000 & --slide 1000) ``` -## Call narrow peaks +## Call peaks on a bam file using an IgG control -```bash -$ ./GoPeaks -b .bam -c .bam -o data/gopeaks/ ``` - -## Call broad peaks - -```bash -$ ./GoPeaks -b .bam -c .bam -o data/gopeaks/ --broad --mdist 3000 +$ ./gopeaks -b .bam -c .bam -o data/gopeaks/ ``` -# Output +## Output Two output files are generated each with the output prefix ${prefix}, set to "sample" by default. @@ -83,30 +72,27 @@ Two output files are generated each with the output prefix ${prefix}, set to "sa ``` head sample_peaks.bed -chr1 9950 10550 -chr1 21250 22650 -chr1 96050 97050 +chr1 9950 10550 +chr1 21250 22650 +chr1 96050 97050 ``` -```bash -$ cat sample_gopeaks.json +``` +cat sample_gopeaks.json { - "gopeaks_version": "1.0.0", - "date": "2021-08-06 11:4:58 AM", - "elapsed": "1m23.43085221s", - "prefix": "sample", - "command": "./gopeaks -b test/K562_1_H3K4me3.ban.sorted.markd.bam -c test/K562_1_IgG.ban.sorted.markd.bam -o K562_1_H3K4me3", - "peak_counts": 10329 + "gopeaks_version": "1.0.0", + "date": "2021-08-06 11:4:58 AM", + "elapsed": "1m23.43085221s", + "prefix": "sample", + "peak_counts": 4765 } ``` -# Recommended parameters +## Recommended parameters | Sequencing Modality | Recommended Parameters | | ---------------------------------------- | ---------------------------- | | CUT&TAG or CUT&RUN narrow peaks | Default parameters | | CUT&TAG or CUT&RUN transcription factors | Default parameters | -| ATAC-Seq | Default parameters | -| ChIP-Seq narrow peaks | Default parameters | | CUT&TAG or CUT&RUN broad peaks | `--broad` and `--mdist 3000` | -| ChIP-Seq broad peaks | `--broad` and `--mdist 3000` | \ No newline at end of file +| ATAC-Seq | Default parameters |