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

README file #55

Merged
merged 7 commits into from
Feb 15, 2024
Merged

README file #55

merged 7 commits into from
Feb 15, 2024

Conversation

JagGlo
Copy link
Contributor

@JagGlo JagGlo commented Feb 8, 2024

closes #31

@JagGlo JagGlo changed the title README README file Feb 8, 2024
@JagGlo JagGlo requested review from salatak and kamilsi February 8, 2024 13:32
Copy link

codecov bot commented Feb 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (9337ed5) 92.61% compared to head (4b72c81) 82.36%.

❗ Current head 4b72c81 differs from pull request most recent head ddcfcf6. Consider uploading reports for the commit ddcfcf6 to get more accurate results

Additional details and impacted files
@@             Coverage Diff             @@
##            devel      #55       +/-   ##
===========================================
- Coverage   92.61%   82.36%   -10.26%     
===========================================
  Files           7        7               
  Lines         447      448        +1     
===========================================
- Hits          414      369       -45     
- Misses         33       79       +46     

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

Copy link
Contributor

@kamilsi kamilsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @JagGlo,

Firstly, I want to thank youn for the effort and dedication you've put into creating the documentation for the project, it shows!

After reviewing the documentation, I believe there's an opportunity for us to further align it with the strategic vision of the unbiased project. While the R package component is undoubtedly important and will be thoroughly documented through GitHub Pages and pkgdown, the core value and unique selling proposition of unbiased actually lie in its API, DB integration, and our development practices, especially our commitment to extensive code coverage. These elements are what truly differentiate unbiased as a production-ready solution for integration with eCRF / EDC software.

Therefore, I suggest we pivot our documentation focus towards highlighting the API, DB, and development practices. By doing so, we can more accurately showcase unbiased's strengths and its readiness for critical applications in clinical research environments. This approach will not only differentiate our project but also clearly communicate its main benefits and applications to our target audience.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kamilsi kamilsi self-requested a review February 15, 2024 10:36
Copy link
Contributor

@kamilsi kamilsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work, let's create a followup issues if those places with remarks were not planned / intended.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@kamilsi kamilsi merged commit 834d1ad into devel Feb 15, 2024
@kamilsi kamilsi deleted the 31_documentation branch February 15, 2024 10:52
This was referenced Feb 15, 2024
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.

3 participants