Skip to content

Commit eb1c20b

Browse files
committed
Updating code examples and installation in README
1 parent 8ebed15 commit eb1c20b

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,19 @@ install.packages('primerTree')
2121
#### Github ####
2222
```s
2323
# install.packages("devtools")
24-
devtools::install_github("jimhester/primerTree")
24+
devtools::install_github("mvesuviusc/primerTree")
2525
```
2626
### [Clustal Omega](http://www.clustal.org/omega/#Download) Installation ###
2727
#### Windows ####
2828
Use the pre-compiled windows binary. Either put the installed clustalo.exe in your path, or pass the path to the executable in the clustal_options option
2929
```s
3030
library(primerTree)
31-
mammals_16S = search_primer_pair(name='Mammals 16S',
32-
'CGGTTGGGGTGACCTCGGA', 'GCTGTTATCCCTAGGGTAACT', clustal_options=c(exec='C:\Program Files\Clustal Omega\clustalo.exe'))
31+
mammals_16S <- search_primer_pair(
32+
name = 'Mammals 16S',
33+
'CGGTTGGGGTGACCTCGGA',
34+
'GCTGTTATCCCTAGGGTAACT',
35+
clustal_options = c(exec = 'C:\Program Files\Clustal Omega\clustalo.exe')
36+
)
3337
```
3438
#### Linux ####
3539
Simple installation from source
@@ -62,7 +66,11 @@ From the clustalo directory:
6266
Simple search for a Mammal 16S primer
6367
```s
6468
library(primerTree)
65-
mammals_16S = search_primer_pair(name='Mammals 16S', 'CGGTTGGGGTGACCTCGGA', 'GCTGTTATCCCTAGGGTAACT')
69+
mammals_16S <- search_primer_pair(
70+
name = 'Mammals 16S',
71+
'CGGTTGGGGTGACCTCGGA',
72+
'GCTGTTATCCCTAGGGTAACT'
73+
)
6674
plot(mammals_16S)
6775
```
6876

@@ -71,7 +79,11 @@ Using the parallel features with the multicore package using the doMC backend, w
7179
library(doMC)
7280
registerDoMC(8)
7381
library(primerTree)
74-
mammals_16S = search_primer_pair(name='Mammals 16S',
75-
'CGGTTGGGGTGACCTCGGA', 'GCTGTTATCCCTAGGGTAACT', .parallel=T)
82+
mammals_16S <- search_primer_pair(
83+
name = 'Mammals 16S',
84+
'CGGTTGGGGTGACCTCGGA',
85+
'GCTGTTATCCCTAGGGTAACT',
86+
.parallel = TRUE
87+
)
7688
plot(mammals_16S)
7789
```

0 commit comments

Comments
 (0)