Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Set up a Quarto manuscript for project #22

Open
5 tasks
ybarkley opened this issue Feb 4, 2025 · 4 comments
Open
5 tasks

Set up a Quarto manuscript for project #22

ybarkley opened this issue Feb 4, 2025 · 4 comments
Assignees

Comments

@ybarkley
Copy link

ybarkley commented Feb 4, 2025

What does it take to write a manuscript in Quarto? This is similar to groups working on SARS, but in my case, it would be for a one-off project.

  • Look up/find template from SARs folks and clone it (?)
  • Create my own qmd from template
  • Edit to make barebones outline specific to my document (title, intro, methods, etc)
  • make tentative plan about figures, tables, maps to include
  • Decide what inputs are needed: csvs, scripts, docs, etc
@ybarkley ybarkley converted this from a draft issue Feb 4, 2025
@jules32
Copy link

jules32 commented Feb 4, 2025

Hi @ybarkley! @LorenStearmanNOAA could be a good person to collaborate with, he just started adding details to #21

@ybarkley ybarkley self-assigned this Feb 6, 2025
@LorenStearmanNOAA
Copy link

Hi @ybarkley! We (the Idaho Wild Fish team at the Pasco station) are at a similar point developing the workflow for a manuscript. We'd be happy to collaborate on process.

@stefaniebutland
Copy link
Member

tagging @shannonrankin for 👀

@shannonrankin
Copy link

@ybarkley Yvonne!
FYI, if any of this is helpful:

  • As part of the PAM-SI, we've created a Research Compendium Template (see instructions here). This page has some info that might be useful for acoustics projects as some of our data is too big for Github, and there are suggested approaches. This specific template has a web output, but beyond that-- the folder organization was based on reviewing what other smart people did and from some of my own learning/tripping through this. Also, consider the info in the readme.
  • Before you dive too deep, I would consider the formatting required for your manuscript. Here is an example repo using a specific template for a journal and quarto (Beaked Whale Banter)-- this was what I consider a reasonable learning curve.
  • If you ultimately need to export your document to WORD and in a specific format, I would run a test BEFORE committing. I had a nightmare of this last year trying to format for export in word in very specific formats-- and ultimately I lost a few weeks effort and had to start from scratch in word (outside of github). Perhaps others have better experiences, but I would test it out before committing too deeply. PDF is not so bad, but specifically formatted Word was a nightmare.
  • If you learn things that can be used to improve our research compendium template (or have suggestions for an alternative template with different output), please reach out! This is just a starting place.

Just some thoughts that might be helpful (or not!). :) Good luck!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Ideas
Development

No branches or pull requests

5 participants