Submitting a Vignette to the DANTE Project

Joshua BrinksISciences, LLC 

Keywords:

contribute

Contents:

Introduction

The DANTE Project provides an open source community platform to lower the barriers of entry to climate security research and policy making. One of the core components of the project are research vignettes and tutorials. DANTE Project submissions are free, and provide a platform for prospective research, methods papers, and scientific tutorials with minimal review from our editors in addition to feedback from our userbase. This is an excellent opportunity for advanced undergraduate work, a consolidated location for teaching materials, and lighter or otherwise less refined research papers from those either lacking publication funds or time for a formal review process. We intend to provide a platform for written works encompassing a wide range of styling and tones. These include, but are not limited to:

  • Traditional R package vignettes.
  • Research blog posts with anecdotal introductions and a lighter tone.
  • Methods papers illustrating a new or otherwise novel data processing and visualization workflow.
  • Working papers or other reproducible scientific papers relaying models or other statistical inference.

In addition to the written content and reproducible code, danteSubmit vignettes require several additional metadata fields to supplement the written content and provide a variety of cross-referenced complementary materials:

  • R packages or other software utilized for the vignette.
  • Datasets used for the creation of the vignette.
  • Data types used in the submission.
  • Accompanying vignettes related to the submission.
  • Direct commentary from DANTE users.

Completing the Template

Accessing the RMarkdown Template

The danteSubmit package can be installed vit GitLab with the devtools package using the following command:

devtools::install_gitlab("/dante-sttr/danteSubmit")

Following installation, the dataset template will be accessible in RStudio through the File > New File > R Mardown ... > From Template > Dante Vignette Submission menu. This will create a new directory in your home directory with the dataset skeleton.Rmd file. This provides the framework of the submission with several DANTE specific metadata fields.

Template Fields

RMarkdown skeleton.Rmd files are typically comprised of two sections: 1) the YAML metadata, and 2) the text body. The skeleton.Rmd begins with the YAML header. It is demarcated by two sets of ---. The text body uses traditional sectioning with the RMarkdown language. More information pertaining to RMarkdown formatting can be found on their official site. UDANTE vignette submissions require no prior knowledge of RMarkdown syntax and users may delete any YAML fields not relevant to the dataset (additional authors, pros, cons, spatial information for non-spatial data, etc.)

YAML Metadata

  • title: The official title of the vignette submission. The title must be inside quotes.

  • metadata-date: You may set it manually or leave as is, and it will automatically generate the date when compiled.

  • author: Name(s), email(s), and affiliation(s) (if applicable), of the individual(s) or institution(s) who authored the submission.

  • vignette-highlights: Bullet points relaying key points of submission.

  • abstract: An abstract should accompany the submission in the event of a methods or working paper submission. The abstract should briefly outline the conceptual approach and highlight important findings. The abstract must be enclosed in quotes.

  • data-presentation-forms: Categorical identifier(s) of submitted data. May be one or more of the following: raster, spatial polygons, spatial points, time series, or dyadic.

  • related-packages: R packages used or referenced in the creation of the vignette.

  • related-datasets: Datasets featured in the vignette. When possible, titles should match those found in the DANTE Project Citation Repository.

  • related-vignettes: Vignettes or other tutorials related to or referenced in the submission.

  • keywords: Keywords for submission.

  • bibliography: Bibtex file containing citations used in body of the submission. This file should be placed in the home directory along with the skeleton.Rmd and any imagery.

  • browse-image: File name for the image to be used while browsing on the DANTE website. This may be left blank for project administrators to handle. If you would like to provide an image please crop it to 300 x 225 pixels.

  • output: This identifies the rmarkdown template to compile the submission. Should not be altered by the user.

Body

The DANTE Project does not mandate any given format for submissions, however, we suggest submissions loosely follow traditional formats and employ logical sectioning and organization. For more information on advanced Rmarkdown formatting reference their official site or the plethora of online materials. Moreover, one may examine markdown files for other DANTE Project at our project GitLab repository. Despite our general flexibility all submissions should contain and introduction and reference section.

  • Introduction: An informative introduction, with references when possible, illustrating the purpose of the submission.

  • Reference: This should not be altered by the user. It will generate the reference list for the for the submission.

Additional Meta-Data

Add new comment

Plain text

  • Allowed HTML tags: <a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type> <li> <dl> <dt> <dd>
  • No HTML tags allowed.
  • Web page addresses and email addresses turn into links automatically.