docs: reorganise documentation and simplify installation guide #36
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix formatting and removed the python code Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Updated installation instructions for acro-r, including prerequisites and step-by-step guidance for setting up Python and R environments. Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Added a comprehensive installation guide for the acro package, including instructions for CRAN and GitHub installation, prerequisites, initialization, troubleshooting, and verification steps. Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
This document introduces the ACRO-R package, its features, and usage instructions. It also includes acknowledgements and links to relevant resources. Signed-off-by: Jessica Ikechukwu <Jessica.Ikechukwu@uwe.ac.uk>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #36 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 5 5
Lines 107 107
=========================================
Hits 107 107 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
JessUWE
changed the title
rpreen
changed the title
rpreen
approved these changes
Jan 20, 2026
Collaborator
rpreen
left a comment
rpreen
left a comment
There was a problem hiding this comment.
This looks ok to me; but it heavily modifies the existing INSTALL.md that @jim-smith wrote, so he should probably confirm this one.
Contributor
Author
|
@jim-smith Could you please take a look at the INSTALL.md file to check that it makes sense? |
Collaborator
|
@JessUWE you've removed a load of key details from the installation guide Those may have benefitted from simplifying, but threes ket stuff about changing the value of the environment variable RETICULATE.PYTHON without which it doesn't work- see e.g. what users had to do it the issue about adding conda support |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Deleted non-functional files from the inst folder: Examples.md, installation.md, supports.md, and welcome.md. Updated the _pkgdown.yml file to reference the new articles located in the Vignettes folder. Created new .Rmd files for installation, supports, welcome, and examples. Revised the Readme.md and Install.md files by removing most of the Python installation configuration code.