-
-
Notifications
You must be signed in to change notification settings - Fork 106
Description
Submitting Author Name: Maëlle Salmon
Submitting Author Github Handle: @maelle
Other Package Authors Github handles: (comma separated, delete if none) @Nenuial
Repository: https://github.com/ropensci-review-tools/babelquarto/
Version submitted: 0.0.1
Submission type: Standard
Editor: @ronnyhdez
Reviewers: @EllaKaye, @joaojcorreia
Archive: TBD
Version accepted: TBD
Language: en
- Paste the full DESCRIPTION file inside a code block below:
Package: babelquarto
Title: Renders a Multilingual Quarto Book
Version: 0.0.1
Authors@R: c(
person("Maëlle", "Salmon", , "[email protected]", role = c("cre", "aut"),
comment = c(ORCID = "0000-0002-2815-0399")),
person("Johannes", "Ranke", role = "ctb"),
person("Joel H.", "Nitta", , "[email protected]", role = "ctb",
comment = c(ORCID = "0000-0003-4719-7472")),
person("Pascal", "Burkhard", , "[email protected]", role = "aut",
comment = c(ORCID = "0009-0001-5504-5084")),
person("rOpenSci", role = "fnd",
comment = c(ROR = "019jywm96"))
)
Description: Automate rendering and cross-linking of Quarto books following a
prescribed structure.
License: MIT + file LICENSE
Encoding: UTF-8
Roxygen: list(markdown = TRUE, roclets = c("collate", "rd", "namespace", "devtag::dev_roclet"))
RoxygenNote: 7.3.2.9000
Imports:
brio,
cli,
fs,
purrr,
quarto,
rlang,
sys,
whoami,
withr,
xml2,
yaml
Depends:
R (>= 4.1.0)
Suggests:
servr,
testthat (>= 3.0.0)
URL: https://github.com/ropensci-review-tools/babelquarto
BugReports: https://github.com/ropensci-review-tools/babelquarto/issues
Config/testthat/edition: 3
VignetteBuilder:
quarto
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
- data validation and testing
- workflow automation
- version control
- citation management and bibliometrics
- scientific software wrappers
- field and lab reproducibility tools
- database software bindings
- geospatial data
- translation
- rOpenSci tools
-
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
It was developed by rOpenSci staff.
Based on https://devdevguide.netlify.app/softwarereview_policies#aims-and-scope, it also falls under the "traduction" category as it allows to publish multilingual documentation.
- Who is the target audience and what are scientific applications of this package?
This package is useful for Quarto users who need to publish a multilingual Quarto website or book, as it is not possible in native Quarto yet.
The package can be used to publish any kind of Quarto website/book but use cases include, beyond several rOpenSci guides, Joel Nitta's personal website, a R handbook for epidemiologists, a website for training courses in epidemiology.
- Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category?
No, not to my knowledge. 😄
- (If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research?
N/A
-
If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or
@tagthe editor you contacted. -
Explain reasons for any
pkgcheckitems which your package is unable to pass.
Technical checks
Confirm each of the following by checking the box.
- I have read the rOpenSci packaging guide.
- I have read the author guide and I expect to maintain this package for at least 2 years or to find a replacement.
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.
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.