Skip to content

Commit

Permalink
update the citation information
Browse files Browse the repository at this point in the history
  • Loading branch information
yjx1217 committed May 3, 2018
1 parent b2201cc commit 09d78f3
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ PATH=$gnuplot_dir:$PATH
###########################################
# set project-specific variables
prefix="SK1" # file name prefix for the output files
reads="$LRSDAY_HOME/Project_Example/00.Long_Reads/SK1.filtered_subreads.fastq.gz" # full path of the long reads file (in fastq or fastq.gz format)
reads="./../00.Long_Reads/SK1.filtered_subreads.fastq.gz" # path of the long reads file (in fastq or fastq.gz format)
reads_type="pacbio-raw" # long reads data type: "pacbio-raw" or "pacbio-corrected" or "nanopore-raw" or "nanopore-corrected"
genome_size="12.5m" # estimated genome size with the format of <number>[g|m|k], e.g. 12.5m for 12.5 Mb
threads=1 # number of threads to use
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
set -e -o pipefail
# set -e -o pipefail
#######################################
# load environment variables for LRSDAY
source ./../../env.sh
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ output_gff="$prefix.orthology_map.gff3"

test_file_existence () {
filename=$1
if [ ! -f $filename ]
if [[ ! -f $filename ]]
then
echo "the file $filename does not exists! process terminated!"
exit
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,22 @@ Long-read sequencing technologies have become increasingly popular in genome pro


## Citations
Jia-Xing Yue & Gianni Liti. (2018) Long-read sequencing data analysis for yeasts (LRSDAY). *Nature Protocols* (accepted pending minor revision; preprint available at http://www.biorxiv.org/content/early/2017/09/05/184572)
Jia-Xing Yue & Gianni Liti. (2018) Long-read sequencing data analysis for yeasts. *Nature Protocols*, 13:1213–1231. (preprint available at http://www.biorxiv.org/content/early/2017/09/05/184572)

Jia-Xing Yue, Jing Li, Louise Aigrain, Johan Hallin, Karl Persson, Karen Oliver, Anders Bergström, Paul Coupland, Jonas Warringer, Marco Cosentino Lagomarsino, Gilles Fischer, Richard Durbin, Gianni Liti. (2017) Contrasting evolutionary genome dynamics between domesticated and wild yeasts. *Nature Genetics*, 49:913-924.

## Current version
* v1.0.0 Released on 2018/02/04

An updated version that incorporate a few additonal long-read-based assemblers is currently under active testing and expected to be release soon.

## License
LRSDAY itself is distributed under the MIT license. A number of LRSDAY's dependencies (e.g. CAP3, MAKER, GATK, blat, RepBase, etc) are under more restricted licenses, for which commerical use of the software needs to be discussed with the corresponding developers.


## Requirements
### Hardware, operating system and network
This protocol is designed for a desktop or computing server running an x86-64-bit Linux operating system. Multithreaded processors are preferred to speed up the process since many steps can be configured to use multiple threads in parallel. For assembling and analyzing the budding yeast genomes (genome size = ~12 Mb), at least 16 Gb of RAM and 100 Gb of free disk space are reccomended. When adapted for other eukaryotic organisms with larger genome sizes, the RAM and disk space consumption will scale up, majorly during de novo genome assembly (performed by [Canu](https://github.com/marbl/canu). Plese refer to [Canu’s manual](http://canu.readthedocs.io/en/latest/) for suggested RAM and disk space consumption for assembling large genomes. Stable Internet connection is required for the installation and configuration of LRSDAY as well as for retrieving the test data.
This protocol is designed for a desktop or computing server running an x86-64-bit Linux operating system. Multithreaded processors are preferred to speed up the process since many steps can be configured to use multiple threads in parallel. For assembling and analyzing the budding yeast genomes (genome size = ~12 Mb), at least 16 Gb of RAM and 100 Gb of free disk space are recomended. When adapted for other eukaryotic organisms with larger genome sizes, the RAM and disk space consumption will scale up, majorly during de novo genome assembly (performed by [Canu](https://github.com/marbl/canu). Plese refer to [Canu’s manual](http://canu.readthedocs.io/en/latest/) for suggested RAM and disk space consumption for assembling large genomes. Stable Internet connection is required for the installation and configuration of LRSDAY as well as for retrieving the test data.


### Software or library requirements
Expand Down
2 changes: 1 addition & 1 deletion pipelines/LRSDAY.01.Long-read-based_Genome_Assembly.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ PATH=$gnuplot_dir:$PATH
###########################################
# set project-specific variables
prefix="SK1" # file name prefix for the output files
reads="$LRSDAY_HOME/Project_Example/00.Long_Reads/SK1.filtered_subreads.fastq.gz" # full path of the long reads file (in fastq or fastq.gz format)
reads="./../00.Long_Reads/SK1.filtered_subreads.fastq.gz" # path of the long reads file (in fastq or fastq.gz format)
reads_type="pacbio-raw" # long reads data type: "pacbio-raw" or "pacbio-corrected" or "nanopore-raw" or "nanopore-corrected"
genome_size="12.5m" # estimated genome size with the format of <number>[g|m|k], e.g. 12.5m for 12.5 Mb
threads=1 # number of threads to use
Expand Down
2 changes: 1 addition & 1 deletion pipelines/LRSDAY.08.Gene_Annotation.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#!/bin/bash
set -e -o pipefail
# set -e -o pipefail
#######################################
# load environment variables for LRSDAY
source ./../../env.sh
Expand Down
2 changes: 1 addition & 1 deletion pipelines/LRSDAY.12.Gene_Orthology_Identification.sh
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ output_gff="$prefix.orthology_map.gff3"

test_file_existence () {
filename=$1
if [ ! -f $filename ]
if [[ ! -f $filename ]]
then
echo "the file $filename does not exists! process terminated!"
exit
Expand Down

0 comments on commit 09d78f3

Please sign in to comment.