diff --git a/README b/README index 0b7525e442559602f5e9576776000a7b410b2bda..286d1a364629d4217c50c0c27137f1b30cc0ada1 100755 --- a/README +++ b/README @@ -13,11 +13,16 @@ BEDTools is a collection of utilities for comparing, summarizing, and intersecting genomic features in the ubiquitous UCSC Genome Browser BED format. +===Manual=== +See the PDF manual included in this distribution for more details on usage, file formats, behavior, etc. + + ===BEDTools=== intersectBed Returns overlaps between two BED files. pairToBed Returns overlaps between a paired-end BED file and a regular BED file. pairToPair Returns overlaps between two paired-end BED files. +bamToBed Converts alignments in BAM format to BED or BEDPE format windowBed Returns overlaps between two BED files within a user-defined window. closestBed Returns the closest feature to each entry in a BED file. subtractBed Removes the portion of an interval that is overlapped by another feature. @@ -44,37 +49,5 @@ complementBed Returns all genomic intervals not spanned by the features in a B 7. Use the tools. -===Acknowledgments=== -1. Jim Kent, UCSC. -Much of the code herein is based upon the genome binning algorithm that Jim developed for the UCSC Browser. I am grateful for the clear explanation of the method and the open source code base. - -2. Michael Stromberg, Boston College. -I learned much of what I know about C++ style from Michael Stromberg. I was formerly a C and Perl -programmer and struggled to switch to C++. The structure of BEDTools and much of the coding style -emulates Michael's. Thanks Mike! - -3. Galaxy. -I had been using Galaxy for months prior to writing these tools. Much of the functionality is based on what is -available on the Galaxy website. I merely found it too slow to do several iterations of queries on a website, -especially with large sequencing datasets. Regardless, I am grateful to the Galaxy team for creating such a -useful site. - -4. Ira Hall, UVa. -Discussions between Ira and I are largely the motivation for these tools. We are frequently tracking -down ad hoc ideas and these tools were originally designed to facilitate such tangents. - -5. Royden Clark, UVa -Royden is the resident UCSC browser expert. He has helped me immensely by teaching me how to squeeze every last bit of functionality from the browser. Also, the algorithmic concept behind the genomeCoverageBed program is Royden's. - -6. Fitz Elliot, UVa -Fitz kindly taught me the ways of version control with git. For those that are constantly confused by CVS and SVN, try git. I think you'll be happy. - -7. Loyal Goff, CSAIL, Broad. -Many thanks to Loyal for his assistance in making BED Tools "compilable" on the SUSE platform. I appreciate your help and patience. - - -===Requests=== -I would be grateful to learn of any problems or suggestions you have for improving these tools. - diff --git a/src/intersectBed/Makefile b/src/intersectBed/Makefile old mode 100755 new mode 100644 index bdb5bd907aef7d1bde76dc44e2ffbc30216d1275..0fc00da2a76ff3f1fc067af986677929d02e0909 --- a/src/intersectBed/Makefile +++ b/src/intersectBed/Makefile @@ -1,6 +1,8 @@ -CXX= g++ -CXXFLAGS= -Wall -O3 -LIBS= -lz +CXX = g++ +CXXFLAGS = -O3 -Wall +LDFLAGS = +LIBS= -lz + UTILITIES_DIR = ../utils/ OBJ_DIR = ../../obj/ BIN_DIR = ../../bin/ @@ -8,7 +10,7 @@ BIN_DIR = ../../bin/ # ------------------- # define our includes # ------------------- -INCLUDES = -I$(UTILITIES_DIR)/BamTools/ -I$(UTILITIES_DIR)/bedFile/ -I$(UTILITIES_DIR)/lineFileUtilities/ -I$(UTILITIES_DIR)/version/ +INCLUDES = -I$(UTILITIES_DIR)/bedFile/ -I$(UTILITIES_DIR)/lineFileUtilities/ -I$(UTILITIES_DIR)/version/ -I$(UTILITIES_DIR)/BamTools/ # ---------------------------------- # define our source and object files @@ -20,12 +22,10 @@ EXT_OBJECTS=$(patsubst %,$(OBJ_DIR)/%,$(_EXT_OBJECTS)) BUILT_OBJECTS= $(patsubst %,$(OBJ_DIR)/%,$(OBJECTS)) PROGRAM= intersectBed - all: $(PROGRAM) .PHONY: all - $(PROGRAM): $(BUILT_OBJECTS) $(EXT_OBJECTS) @echo " * linking $(PROGRAM)" @$(CXX) $(LDFLAGS) $(CXXFLAGS) -o $(BIN_DIR)/$@ $^ $(LIBS) @@ -38,9 +38,9 @@ $(EXT_OBJECTS): @$(MAKE) --no-print-directory -C $(UTILITIES_DIR)/bedFile/ @$(MAKE) --no-print-directory -C $(UTILITIES_DIR)/lineFileUtilities/ @$(MAKE) --no-print-directory -C $(UTILITIES_DIR)/BamTools/ - + clean: @echo "Cleaning up." @rm -f $(OBJ_DIR)/* $(BIN_DIR)/* -.PHONY: clean \ No newline at end of file +.PHONY: clean diff --git a/src/utils/version/version.h b/src/utils/version/version.h index a432fa29ae22918974fe6a536182eaeb75dd436a..f469cbd8bf492e2a059e85504c4529cfa0087508 100644 --- a/src/utils/version/version.h +++ b/src/utils/version/version.h @@ -3,6 +3,6 @@ // define the version. All tools in the // suite carry the same version number. -#define VERSION "2.3.3" +#define VERSION "2.4.0" #endif /* VERSION_H */