Skip to content

Commit 98988c2

Browse files
committed
INSTALL.md v2024-04-16; commented out block on appending /get_phylomarkers/lib/R to R_LIBS_SITE
1 parent dc73609 commit 98988c2

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

INSTALL.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ Alternatively, you can try to perform a manual install, as follows:
2525
- Debian/Ubuntu users cd into get_phylomarkers/ and run <code>./apt-install_R_dependencies.sh</code>, which is the preferred way to manage R packages on these systems
2626
- Other Linux users cd into get_phylomarkers/ and run <code>./install_R_deps.R</code>, which will install R packages into get_phylomarkers/lib/R
2727
- For all users, the KDEtrees package needs to be installed with the <code>install_kdetrees_from_github.R</code> script
28-
28+
29+
<!--
2930
4. from within the get_phylomarkers distribution directory, as regular user type:
3031
```
3132
rlibs=`for p in $(R -q -e 'print(.libPaths())'); do if [[ "$p" =~ '/' ]]; then echo -n "$p:"; fi; done; echo -n "$wkd"/"$distrodir/lib/R"` && echo "export R_LIBS_SITE=$rlibs" >> $HOME/.bashrc
@@ -34,14 +35,16 @@ rlibs=`for p in $(R -q -e 'print(.libPaths())'); do if [[ "$p" =~ '/' ]]; then e
3435
cat $HOME/.Rprofile
3536
```
3637
- or as sudo append ':/PATH/TO/get_phylomarkers/lib/R' to <code>R_LIBS_SITE=${R_LIBS_SITE-'/usr/local/lib/R/site-library:/usr/lib/R/site-library:/usr/lib/R/library'}</code> in /etc/R/Profile for system-wide permanent changes for all users and session types.
37-
38-
5. To setup the *libnw* library required by *estimate_pangenome_phylogenies.sh* in parsimony mode (-R 3), type the following <code>'sudo cp /PATH/TO/get_phylomarkers/lib/libnw.so /usr/local/lib && sudo echo "export LD_LIBRARY_PATH=/usr/local/lib" && sudo ldconfig'</code>
3938
40-
6. cd into the test_sequences/core_genome directory, or copy that directory into a suitable place (e.g. 'cp -r test_sequences $HOME && cd $HOME/test_sequences/core_genome')
39+
-->
40+
41+
4. To setup the *libnw* library required by *estimate_pangenome_phylogenies.sh* in parsimony mode (-R 3), type the following <code>'sudo cp /PATH/TO/get_phylomarkers/lib/libnw.so /usr/local/lib && sudo echo "export LD_LIBRARY_PATH=/usr/local/lib" && sudo ldconfig'</code>
42+
43+
5. cd into the test_sequences/core_genome directory, or copy that directory into a suitable place (e.g. 'cp -r test_sequences $HOME && cd $HOME/test_sequences/core_genome')
4144

42-
7. If you want to perform a system-wide install, you will have to become the superuser (e.g. 'sudo su').
45+
6. If you want to perform a system-wide install, you will have to become the superuser (e.g. 'sudo su').
4346

44-
8. If you are running the GET_PHYLOMERKERS release v2.2.0_2024-04-14, you will need to install [snp-sites](https://github.com/sanger-pathogens/snp-sites) on your system:
47+
7. If you are running the GET_PHYLOMERKERS release v2.2.0_2024-04-14, you will need to install [snp-sites](https://github.com/sanger-pathogens/snp-sites) on your system:
4548
- Debian/Ubuntu users can easyly install with <code>apt update && apt install snp-sites</code>
4649
- Other *NIX unsers should compile as follows:
4750
```
@@ -58,14 +61,14 @@ make
5861
sudo make install
5962
```
6063

61-
NOTE: from GET_PHYLOMERKERS release v2.2.1, or run_get_phylomarkers.sh v2.8.1.0_2024-04-15 onwards, the static snp-sites-static binary is provided for Linux users,
62-
meaning that step 8 can be omitted.
64+
NOTE: from GET_PHYLOMERKERS release >= v2.2.1, or run_get_phylomarkers.sh => v2.8.1.0_2024-04-15 onwards, the static snp-sites-static binary is provided for Linux users,
65+
meaning that the previous step (7) can be omitted.
6366

64-
9. Issue the following command from within /path/to/test_sequences/core_genome to test if the distro is working on your system: <code>/path/to/get_phylomarkers/run_get_phylomarkers_pipeline.sh -R 1 -t DNA</code>, which will run in phylogenomics mode (-R 1), on DNA sequences (-t DNA).
67+
8. Issue the following command from within /path/to/test_sequences/core_genome to test if the distro is working on your system: <code>/path/to/get_phylomarkers/run_get_phylomarkers_pipeline.sh -R 1 -t DNA</code>, which will run in phylogenomics mode (-R 1), on DNA sequences (-t DNA).
6568

66-
10. Check it now on the protein level: 'run_get_phylomarkers_pipeline.sh -R 1 -t PROT'. Note that for this second invocation, you will probably not need to prepend the full path to the script anymore, as symlinks were created to the scripts from your $HOME/bin dir, or if you run the lines above with root privileges, from /usr/local/bin.
69+
9. Check it now on the protein level: 'run_get_phylomarkers_pipeline.sh -R 1 -t PROT'. Note that for this second invocation, you will probably not need to prepend the full path to the script anymore, as symlinks were created to the scripts from your $HOME/bin dir, or if you run the lines above with root privileges, from /usr/local/bin.
6770

68-
11. Explore the help menu of the master script to see the options available for customizing the runs. It is printed to STDOUT when issuing run_get_phylomarkers_pipeline.sh -h or simply run_get_phylomarkers_pipeline.sh
71+
10. Explore the help menu of the master script to see the options available for customizing the runs. It is printed to STDOUT when issuing run_get_phylomarkers_pipeline.sh -h or simply run_get_phylomarkers_pipeline.sh
6972

7073
That's it, enjoy!
7174

0 commit comments

Comments
 (0)