diff --git a/docs/README.md b/docs/README.md index ea7c1cd..b044788 100644 --- a/docs/README.md +++ b/docs/README.md @@ -49,37 +49,7 @@ detach("package:HaplotypR", unload=TRUE) devtools::install_github("lerch-a/HaplotypR") ``` -# Run HaplotypR as Shiny App (currently dysfunctional) - -Load HaplotypR package: -```R -library("HaplotypR") -``` - -Copy Example Files to a working directory 'outputDir': -```R -# Define output directory -outputDir <- "~/exampleHaplotypR" -# Create output directoy -if(!dir.exists(outputDir)) - dir.create(outputDir, recursive=T) -# Set working directory to output directory -setwd(outputDir) - -# Copy example files to output directory -file.copy(from=system.file(package="HaplotypR", "extdata"), to=outputDir, recursive = T) -# List files example files in output directory -dir(file.path(outputDir, "extdata")) -``` -The listed file can be used as example input files in the shiny app. The following files should be listed with the last R command: "barcode_Fwd.fasta", "barcode_Rev.fasta", "markerFile.txt", "readsF.fastq.gz", "readsR.fastq.gz", "sampleFile.txt". - - -Run HaplotypR GUI: -```R -runShinyApp() -``` - -# Run HaplotypR on R command line (without shiny app) +# Run HaplotypR on R command line ```R library("HaplotypR") @@ -239,3 +209,33 @@ finalTab <- createFinalHaplotypTable(outputDir=outputDir, sampleTable=procReads, minHaplotypCoverage=minCov, minReplicate=minOccHap, detectability=detectionLimit, minSampleCoverage=minCovSample) ``` + +# Run HaplotypR as Shiny App (currently dysfunctional) + +Load HaplotypR package: +```R +library("HaplotypR") +``` + +Copy Example Files to a working directory 'outputDir': +```R +# Define output directory +outputDir <- "~/exampleHaplotypR" +# Create output directoy +if(!dir.exists(outputDir)) + dir.create(outputDir, recursive=T) +# Set working directory to output directory +setwd(outputDir) + +# Copy example files to output directory +file.copy(from=system.file(package="HaplotypR", "extdata"), to=outputDir, recursive = T) +# List files example files in output directory +dir(file.path(outputDir, "extdata")) +``` +The listed file can be used as example input files in the shiny app. The following files should be listed with the last R command: "barcode_Fwd.fasta", "barcode_Rev.fasta", "markerFile.txt", "readsF.fastq.gz", "readsR.fastq.gz", "sampleFile.txt". + + +Run HaplotypR GUI: +```R +runShinyApp() +```