First, make sure GotCloud is installed on your system. Installation instructions here.
2. Running the Automatic Test
This verifies that GotCloud was installed correctly.
To run the test case automatically, change your current directory to gotcloud's base directory, and type in the following command:
/bin/gen_biopipeline.pl --test OUTPUT_DIR
where OUTPUT_DIR is the directory where you want to store the results.
If you see "Test Passed", then you are ready to run a sample.
3. Running an Example Sample
As an example, we can analyze the sample files used in the automatic test.
To make this easier, change to the test/align directory. It contains an index file and a configuration file that can be used directly.
3.1 Index file
There are four fastq files in test/align/fastq/Sample_1 and four fastq files in test/align/fastq/Sample_2, both in paired-end format. Normally, we would need to build an index file for these files. Conveniently, an index file (indexFile.txt) already exists for the automatic test samples. It contains the following information in tab-delimted format:
MERGE_NAME FASTQ1 FASTQ2 RGID SAMPLE LIBRARY CENTER PLATFORM Sample1 fastq/Sample_1/File1_R1.fastq.gz fastq/Sample_1/File1_R2.fastq.gz RGID1 SampleID1 Lib1 UM ILLUMINA Sample1 fastq/Sample_1/File2_R1.fastq.gz fastq/Sample_1/File2_R2.fastq.gz RGID1a SampleID1 Lib1 UM ILLUMINA Sample2 fastq/Sample_2/File1_R1.fastq.gz fastq/Sample_2/File1_R2.fastq.gz RGID2 SampleID2 Lib2 UM ILLUMINA Sample2 fastq/Sample_2/File2_R1.fastq.gz fastq/Sample_2/File2_R2.fastq.gz RGID2 SampleID2 Lib2 UM ILLUMINA
If you are in the test/align directory, you can use this file as-is. If you prefer, you can create a new index file and change the MERGE_NAME, RGID, SAMPLE, LIBRARY, CENTER, or PLATFORM values. It is recommended that you do not modify existing files in test/align.
If you want to run this example from a different directory, make sure the FASTQ1 and FASTQ2 paths are correct.
3.2 Configuration file
Similar to the index file, a configuration file (test.conf) already exists for the automatic test samples. It contains the following information:
INDEX_FILE = indexFile.txt ############ # References REF_DIR = $(PIPELINE_DIR)/test/align/chr20Ref AS = NCBI37 FA_REF = $(REF_DIR)/human_g1k_v37_chr20.fa DBSNP_VCF = $(REF_DIR)/dbsnp.b130.ncbi37.chr20.vcf.gz PLINK = $(REF_DIR)/hapmap_3.3.b37.chr20
If you are in the test/align directory, you can use this file as-is. If you are using a different index file, make sure your index file is named correctly in the first line.