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

Create docs directory #255

Merged
merged 1 commit into from
Jul 8, 2024
Merged

Create docs directory #255

merged 1 commit into from
Jul 8, 2024

Conversation

ErinBecker
Copy link
Contributor

The read_qc.sh script is inconsistent in creating new directories. Before creating the results/fastqc_untrimmed_reads directory, there is a note that says:

"Our next line will create a new directory to hold our FastQC output files. Here we are using the -p option for mkdir again. It is a good idea to use this option in your shell scripts to avoid running into errors if you do not have the directory structure you think you do."

But then the last line in the script cats the summaries to a new file within the /docs/ directory without first creating that directory. This will run without error for most learners, if they have been following along with the materials, but will fail if someone is using the script independently of the lesson. This PR adds a command to create that /docs/ directory, to be on the safe side and consistent with advice earlier in the episode.

Copy link

github-actions bot commented Jun 14, 2024

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/datacarpentry/wrangling-genomics/compare/md-outputs..md-outputs-PR-255

The following changes were observed in the rendered markdown documents:

 05-automation.md | 1 +
 md5sum.txt       | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-06-14 19:15:06 +0000

github-actions bot pushed a commit that referenced this pull request Jun 14, 2024
@aidamiro
Copy link
Contributor

aidamiro commented Jul 8, 2024

This looks good. Thanks @ErinBecker for your recommendation!

@aidamiro aidamiro merged commit 0effa81 into main Jul 8, 2024
3 checks passed
@aidamiro aidamiro deleted the create-docs branch July 8, 2024 15:27
github-actions bot pushed a commit that referenced this pull request Jul 8, 2024
Auto-generated via {sandpaper}
Source  : 0effa81
Branch  : main
Author  : aidamiro <[email protected]>
Time    : 2024-07-08 15:27:51 +0000
Message : Merge pull request #255 from datacarpentry/create-docs

Create docs directory
github-actions bot pushed a commit that referenced this pull request Jul 8, 2024
Auto-generated via {sandpaper}
Source  : 237afb5
Branch  : md-outputs
Author  : GitHub Actions <[email protected]>
Time    : 2024-07-08 15:28:41 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0effa81
Branch  : main
Author  : aidamiro <[email protected]>
Time    : 2024-07-08 15:27:51 +0000
Message : Merge pull request #255 from datacarpentry/create-docs

Create docs directory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants