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 README files at assay folder level, and clean up inst/ folder #233

Open
wants to merge 24 commits into
base: develop
Choose a base branch
from

Conversation

kelliemac
Copy link
Contributor

@kelliemac kelliemac commented Sep 4, 2024

Description

Instead of creating a README file for each PT report at the time of knitting to visc_pdf_document or visc_word_document, the README file will now be at the assay level and created at the first time that use_visc_report() is called within an assay folder.

Related Issues

Related to #92

Checklist

  • This PR includes unit tests
  • This PR establishes a new function or updates parameters in an existing function
    • The roxygen skeleton for this function has been updated using devtools::document
  • I have updated NEWS.md to describe the proposed changes

@kelliemac kelliemac changed the base branch from main to develop September 4, 2024 23:05
@kelliemac kelliemac marked this pull request as ready for review September 4, 2024 23:07
@kelliemac
Copy link
Contributor Author

@mayerbry to review this PR! Alicia gave verbal approval at our meeting today.

@kelliemac
Copy link
Contributor Author

Per group discussion on 1/7, ok to move templated README to assay level, and also create a blank README file for each report.

Copy link

codecov bot commented Jan 11, 2025

Codecov Report

Attention: Patch coverage is 96.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 82.50%. Comparing base (b8969f4) to head (3be81bf).

Files with missing lines Patch % Lines
R/visc_output_document.R 85.71% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #233      +/-   ##
===========================================
+ Coverage    82.10%   82.50%   +0.39%     
===========================================
  Files            8        8              
  Lines          352      360       +8     
===========================================
+ Hits           289      297       +8     
  Misses          63       63              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kelliemac
Copy link
Contributor Author

since I moved around some of the relevant files, I will go ahead and address #241 now too

@kelliemac
Copy link
Contributor Author

I also added a note about using git tags instead of hashes, in line with #238

@kelliemac kelliemac requested a review from slager January 11, 2025 01:33
@kelliemac kelliemac changed the title Move README creation for PT reports to assay level Create README files at assay folder level, and clean up inst/ folder Jan 11, 2025
@kelliemac
Copy link
Contributor Author

@mayerbry and @slager can you please review this PR when you have a chance? I increased the scope a little bit because I got frustrated with the organization of files in the inst folder while I was updating the README creation steps. so I renamed a bunch of files (all within inst) but didn't actually change their contents for the most part. we had discussed in the past that it was sometimes difficult to find the right files to edit in this package, so I'm hoping the new organization helps with that.

please focus on the following in your review:

  • are the new file names and organization of the inst folder more intuitive than before? are these changes + the additional text in the package README sufficient to address Add quick links in package README for important files #241?
  • are the updated README formats of inst/templates/README_assay_folder.md and inst/templates/README_report_folder.md acceptable?
  • do you have any concerns about the code changes in use_visc_report.R and visc_output_document.R?

thank you!!!

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.

1 participant