Skip to content

Aligning static publication page with publication utilities package and quickstart example #1

@lucy-dwr

Description

@lucy-dwr

I've created a first draft of the static publication page for Data Producers to have general guidance on publishing reproducible datasets to EDI. It will be accompanied by a quickstart guide that walks users through a step-by-step data publication process with an example dataset and code snippets. There will also be supporting docs such as a glossary (e.g., to define terms such as "tidy data," "version control," "staging," "production," etc.) and a thorough style and development guide.

Currently, the static publication page is missing:

  • Short narrative on quality control expectations and documentation
  • Brief discussion of what "raw" data is, where to house it, and how to clean it
  • Discussion of where to document data collection methods and metadata-like supplementary information (e.g., maps)
  • Note on Tribal datasets and other datasets that are not for public release (basically exempting them from this process, in order for their management to align with data sharing agreement terms)

@alvizek - could you edit the static publication page? I've got two asks of you—do you mind doing the following with a pull request?

  1. Ensure that the content on the static publication page matches the hrlpub R package, publication workflow, and example that you're putting together.
  2. Address any of the missing content listed above where you've got ideas, while keeping the page at a higher level and reserving more technical content for the quickstart. Don't feel like you have to do it all, though—just the parts where your work on the utilities package and example workflow intersects!

Thank you! 🙏🙂

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions