Using Markdown

  • Use .md files for episodes when you want static content
  • Use .Rmd files for episodes when you need to generate output
  • Run sandpaper::check_lesson() to identify any issues with your lesson
  • Run sandpaper::build_lesson() to preview your lesson locally

Open Source and Open Science

  • Publishing code is a critical part of making science reproducible
  • Code that is published is less likely to contain mistakes or errors
  • Open development makes it easier to make small changes and updates available to an audience, and allows for checks in real-time

Policy

  • An official USGS software information production is a point-in-time snapshot of a software product that has received the necessary review and approval to be made publicly accessible.
  • Software must be released as an official USGS software information product before it can be cited by other resources (e.g., data releases, journal articles etc.). Local centers may define other factors necessitating a software release.
  • Any software project may be released as an official USGS software information product given it has received the necessary review and approval.

Creating Metadata for a Software Release

  • A code.json file is a file formatted in JavaScript Object Notation (JSON) and contains project metadata. The code.json file is saved at the top-level of the project.
  • USGS compiles all of the code.json files for public products in GitLab into an inventory that is required by Federal policy.
  • You can use a code.json file template to begin creating your project metadata with the required fields.