Description
Date accepted: 2022-12-30
Submitting Author Name: Cristian Román-Palacios
Submitting Author Github Handle: @cromanpa94
Repository: https://github.com/cromanpa94/phruta
Version submitted: 0.1.0
Submission type: Standard
Editor: @annakrystalli
Reviewers: @raynamharris, @fboehm
Due date for @fboehm: 2021-12-16
Archive: TBD
Version accepted: TBD
- Paste the full DESCRIPTION file inside a code block below:
Package: phruta
Type: Package
Title: Phylogenetic Reconstruction and Time-dating
Version: 0.1.0
Authors@R: person("Cristian", "Roman Palacios", email = "cromanpa@g.ucla.edu",
role = c("aut", "cre"))
Description: The phruta R package is designed to simplify the basic
phylogenetic pipeline. Specifically, all code is run within
the same program and data from intermediate steps are saved in
independent folders. Furthrmore, all code is run within the
same environment which increases the reproducibility of your analysis.
phruta retrieves gene sequences, combines newly downloaded and local
gene sequences, and performs sequence alignments.
Encoding: UTF-8
LazyData: true
biocViews: DECIPHER,
Biostrings
Depends: R (>= 3.5.0)
Imports:
rgbif,
pbapply,
rentrez,
taxize,
ape,
ips,
geiger,
methods,
DECIPHER,
Biostrings
RoxygenNote: 7.1.1
Suggests:
testthat (>= 3.0.0),
covr,
knitr,
markdown,
rmarkdown,
spelling,
utf8
VignetteBuilder: knitr
License: MIT + file LICENSE
Config/testthat/edition: 3
Language: en-US
Roxygen: list(markdown = TRUE)
Scope
-
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
- data retrieval
- data extraction
- data munging
- data deposition
- workflow automation
- version control
- citation management and bibliometrics
- scientific software wrappers
- field and lab reproducibility tools
- database software bindings
- geospatial data
- text analysis
-
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
phruta
simplifies the phylogenetic pipeline in R, increases reproducibility, and helps organizing information used to infer molecular phylogenies.phruta
retrieves sequences from genbank, curates the resulting files, perform multiple sequence alignment, and tree inference/dating. -
Who is the target audience and what are scientific applications of this package?
Researchers, students, instructors, and analysts interesting in assembling phylogenies (and even time-calibrated phylogenies) for specific groups across the Tree of Life. -
Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
phylotaR retrieves orthologous clusters for particular clades. However, it has limited flexibility in terms of sampling outgroup taxa and (to my knowledge) does not perform any type of processing after retrieving the clusters. -
(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
-
If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
Technical checks
Confirm each of the following by checking the box.
- I have read the guide for authors and rOpenSci packaging guide.
This package:
- does not violate the Terms of Service of any service it interacts with.
- has a CRAN and OSI accepted license.
- contains a README with instructions for installing the development version.
- includes documentation with examples for all functions, created with roxygen2.
- contains a vignette with examples of its essential functions and uses.
- has a test suite.
- has continuous integration, including reporting of test coverage using services such as Travis CI, Coveralls and/or CodeCov.
Publication options
-
Do you intend for this package to go on CRAN?
-
Do you intend for this package to go on Bioconductor?
-
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
MEE Options
- The package is novel and will be of interest to the broad readership of the journal.
- The manuscript describing the package is no longer than 3000 words.
- You intend to archive the code for the package in a long-term repository which meets the requirements of the journal (see MEE's Policy on Publishing Code)
- (Scope: Do consider MEE's Aims and Scope for your manuscript. We make no guarantee that your manuscript will be within MEE scope.)
- (Although not required, we strongly recommend having a full manuscript prepared when you submit here.)
- (Please do not submit your package separately to Methods in Ecology and Evolution)
Code of conduct
- I agree to abide by rOpenSci's Code of Conduct during the review process and in maintaining my package should it be accepted.