diff --git a/CITATION.md b/CITATION.md index 997f6ddf..9a6fbf3d 100644 --- a/CITATION.md +++ b/CITATION.md @@ -4,7 +4,7 @@ If you use scripts from this repository as part of your published research, please cite the repository as follows (also see DOI information below): -- Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. +- Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. Alternatively, provide the following link to this software repository in your manuscript: @@ -14,7 +14,7 @@ Alternatively, provide the following link to this software repository in your ma The DOI for PIrANHA, via [Zenodo](https://zenodo.org) (also indexed by [OpenAIRE](https://explore.openaire.eu/)), is as follows: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.596766.svg)](https://doi.org/10.5281/zenodo.596766). Here are some examples of citing PIrANHA using the DOI: - Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. + Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. Bagley, J.C. 2020. PIrANHA. Zenodo, Available at: http://doi.org/10.5281/zenodo.596766. @@ -50,4 +50,4 @@ BibTeX entries for LaTeX users are as follows: ``` Justin C. Bagley, Ph.D. -May 27, 2020, St. Louis, MO +December 17, 2020, Jacksonville, AL diff --git a/CODE_OF_CONDUCT.md b/CODE-OF-CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to CODE-OF-CONDUCT.md diff --git a/Quick_Guide.md b/Quick-Guide.md similarity index 97% rename from Quick_Guide.md rename to Quick-Guide.md index 10464bd4..585ec71e 100644 --- a/Quick_Guide.md +++ b/Quick-Guide.md @@ -228,13 +228,13 @@ Questions? Comments? Concerns? Bug fix requests? Feature requests for existing f ### License -All code within **PIrANHA v0.4a3** repository is available "AS IS" under a 3-Clause BSD license. See the [LICENSE](LICENSE) file for more information. +All code within **PIrANHA v0.4a4** repository is available "AS IS" under a 3-Clause BSD license. See the [LICENSE](LICENSE) file for more information. ### Citation If you use scripts from this repository as part of your published research, please cite the repository as follows (also see DOI information below): -- Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. +- Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. Alternatively, provide the following link to this software repository in your manuscript: @@ -244,7 +244,7 @@ Alternatively, provide the following link to this software repository in your ma The DOI for PIrANHA, via [Zenodo](https://zenodo.org) (also indexed by [OpenAIRE](https://explore.openaire.eu/)), is as follows: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.596766.svg)](https://doi.org/10.5281/zenodo.596766). Here are some examples of citing PIrANHA using the DOI: - Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. + Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. Bagley, J.C. 2020. PIrANHA. Zenodo, Available at: http://doi.org/10.5281/zenodo.596766. @@ -259,6 +259,6 @@ if [[ -f /usr/local/bin/local_piranha ]]; then rm -rf /usr/local/bin/local_piran if [[ -f /usr/local/bin/brew_piranha ]]; then rm -rf /usr/local/bin/brew_piranha ; fi ``` -*December 14, 2020* - *Justin C. Bagley, Jacksonville, AL, USA* +*December 17, 2020* - *Justin C. Bagley, Jacksonville, AL, USA* [Next (Introduction) >>](https://github.com/justincbagley/piranha/wiki/1.-Introduction) diff --git a/Quick-Guide.pdf b/Quick-Guide.pdf new file mode 100644 index 00000000..fa92c483 Binary files /dev/null and b/Quick-Guide.pdf differ diff --git a/Quick_Guide.pdf b/Quick_Guide.pdf deleted file mode 100644 index 1acffef2..00000000 Binary files a/Quick_Guide.pdf and /dev/null differ diff --git a/README.md b/README.md index b11ae535..6bd7a2f8 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ For additional information on this distribution, including overview, dependencie ## LICENSE -All code within **PIrANHA v0.4a3** repository is available "AS IS" under a 3-Clause BSD license. See the [LICENSE](LICENSE) file for more information. +All code within **PIrANHA v0.4a4** repository is available "AS IS" under a 3-Clause BSD license. See the [LICENSE](LICENSE) file for more information. ## CITATION @@ -42,7 +42,7 @@ Should you cite **PIrANHA**? See https://github.com/mr-c/shouldacite/blob/master If you use scripts from this repository as part of your published research, please cite the repository as follows (also see DOI information below): -- Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. +- Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub repository, Available at: http://github.com/justincbagley/PIrANHA. Alternatively, provide the following link to this software repository in your manuscript: @@ -52,7 +52,7 @@ Alternatively, provide the following link to this software repository in your ma The DOI for PIrANHA, via [Zenodo](https://zenodo.org) (also indexed by [OpenAIRE](https://explore.openaire.eu/)), is as follows: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.596766.svg)](https://doi.org/10.5281/zenodo.596766). Here are some examples of citing PIrANHA using the DOI: - Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. + Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766. Bagley, J.C. 2020. PIrANHA. Zenodo, Available at: http://doi.org/10.5281/zenodo.596766. diff --git a/changeLog.md b/changeLog.md index 6d3c611b..fca6bcc9 100644 --- a/changeLog.md +++ b/changeLog.md @@ -10,7 +10,7 @@ Development is on-going... -### PIrANHA 0.4a4 (official minor pre-release version v0.4-alpha-4), December 17, 2020 +### PIrANHA v0.4a4 (official minor pre-release version v0.4-alpha-4), December 17, 2020 - **December 15, 2020:** Bug fixes for bad piping and other minor errors in `batchRunFolders` and `FASTAsummary` functions, and added option for specifying number of threads when running `batchRunFolders`. - **December 15, 2020:** Fixed version printing for piranha main script and functions (`piranha -V`, `piranha --version`, `piranha -f -V`, and `piranha -f --version` each now yield expected behavior (terse output). @@ -23,7 +23,7 @@ Development is on-going... - **August 12, 2020:** Updated `trimSeqs` function to improve performance after issue discussion with Juan Moreira. This updated fixed posix space bug, because `[:space:]` should be `[[:space:]]`. - **August 3, 2020:** Updated README, as well as Quick Guide for [wiki](https://github.com/justincbagley/piranha/wiki). -### PIrANHA 0.4a3 (official minor pre-release version v0.4-alpha-3), July 31, 2020 +### PIrANHA v0.4a3 (official minor pre-release version v0.4-alpha-3), July 31, 2020 - **July 31, 2020:** Added new `trimSeqs` function and prepped 0.4a3 release by updating versioning of main `piranha` script and function scipts, and also updating Wiki and READMEs. The `trimSeqs` function automates trimming one or multiple DNA sequence alignments in PHYLIP format, with options for custom gap handling parameters for trimAl, and with trimmed alignments output to FASTA, PHYLIP, or NEXUS formats. - **May 27, 2020:** Updated repo with new citation file ('CITATION.md'), code of conduct for developers ('CODE_OF_CONDUCT.md'), and license ('LICENSE'). @@ -31,7 +31,7 @@ Development is on-going... - **April 18-20, 2020:** This update builds on the previous pre-release, v0.4a2, by adding minor bug fixes and improvements to several functions. With the addition of the new function `alignAlleles`, a companion script meant to be run directly after `phaseAlleles`, this release establishes a new workflow for phasing and aligning consensus sequences from HTS (e.g. targeted sequence capture data) based on reads (re)mapped to a reference assembly FASTA file (i.e. following reference-based assembly). This combination of programs was designed to be run on target capture data after first conducting cleaning, assembly, locus selection, and reference-based assembly (specifically, with SECAPR (Andermann et al. 2018) in mind, and with testing based on output from SECAPR). - **April 17, 2020:** Added "Quick Guide" to wiki, entitled "Quick Guide for the Impatient," with install instructions and example code. -### PIrANHA 0.4a2 (official minor pre-release version v0.4\-alpha\-2), April 17, 2020 +### PIrANHA v0.4a2 (official minor pre-release version v0.4\-alpha\-2), April 17, 2020 - **April 13-17, 2020:** This update builds on the previous pre-release, v0.4a, by updating the main `prianha` script (including improvements to messaging and help text); addition of a new `phaseAlleles` function that automates phasing of consensus sequences from HTS (e.g. targeted sequence capture) based on a (re)mapped assembly reference FASTA; as well as minor updates to all functions (improved messaging and minor bug fixes). diff --git a/index.html b/index.html index 3d4cfd98..2269ac75 100644 --- a/index.html +++ b/index.html @@ -168,12 +168,12 @@

LICENSE

-

All code within the PIrANHA v0.4a3 repository is available “AS IS” under a 3-Clause BSD license. See the LICENSE file for more information.

+

All code within the PIrANHA v0.4a4 repository is available “AS IS” under a 3-Clause BSD license. See the LICENSE file for more information.

CITATION

If you use scripts from this repository as part of your published research, I require that you cite the repository as follows (also see DOI information below):

Alternatively, please provide the following link to this software repository in your manuscript:

@@ -183,7 +183,7 @@

CITATION

DOI

The DOI for PIrANHA, via Zenodo, is as follows: DOI. Here are some examples of citing PIrANHA using the DOI:

-

Bagley, J.C. 2020. PIrANHA v0.4a3. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766.

+

Bagley, J.C. 2020. PIrANHA v0.4a4. GitHub package, Available at: http://doi.org/10.5281/zenodo.596766.

Bagley, J.C. 2020. PIrANHA. Zenodo, Available at: http://doi.org/10.5281/zenodo.596766.

DOCUMENTATION