Tworzenie pakietów w programie R

Tworzenie pakietów w programie R
\note{}- krótkie uwagi o pakiecie
\seealso{} - odnośniki do dokumentacji innych funkcji, do tworzenia linków używamy
\code{\link{innafunkcja}}.
Do edycji tekstu sluża, komendy.
\emph{} - tekst pisany kursywa.,
\stronger{} - tekst pogrubiony i pisany kursywa.,
\bold{} - tekst pogrubiony.
\sQuote{}, \dQuote{} - tekst cytowany, pojedyńcze i podwójne znaki cytowania.
Formuly matematyczne zapisujemy używajac
, \eqn{}{} albo \deqn{}{}, gdzie tekst z pierwszego nawiasu jest w kodzie Tex i bedzie
skompilowany i umieszczony w dokumentacji,
,
natomiast na stronie html pokaże sie, napis w kodzie ASCII z drugiego nawiasu. Można
umieścić jeden nawias jeśli tekst w ASCII i latexu jest taki sam.
Przy tworzeniu pakietów pomocne sa, funkcje zawarte w bibliotekach utils oraz tools. Wszystkie poniższe komendy wpisujemy w oknie konsoli R.
package.skeleton() - tworzy w katalogu roboczym strukture, katalogów pakietu (katalog
z funkcjami, zbiorami danych, dokumentacja oraz plikiem description).
showNonASCII(tekst) - wczytuje tekst i zaznacza miejsce użycia znaków innych niż
ASCII.
prompt(plik) - tworzy w katalogu roboczym plik dokumentacji zbioru danych o nazwie
plik.Rd, jest to formularz do wypelnienia i przekopiowania do katalogu z dokumentacja, budowanego pakietu.
install.packages() - instaluje na dysku wybrany pakiet. Do wyboru pliku pomocna jest
funkcja file.choose().
remove.packages() - usuwa z dysku wybrany pakiet. Domyślnie przeszukiwany jest katKomendy R CMD
alog .libPaths(), należy pamietać
iż nazwe, pakietu podajemy w ” ”.
,
Wszystkie poniższe komendy do wpisania w oknie poleceń systemu Windows, w katalogu domowym R, w podkatalogu bin. Należy pamietać
o tym że budowany, instalowany i sprawdzany
Komendy dokumentacji
,
pakiet domyślnie musi znajdować sie, w katalogu roboczym R. Do uruchomienia niektórych z
Poniższych komend używamy w pikach .Rd. Sposób zapisu komend podobny do skladni la- niżej opisanych funkcji potrzeba zainstalowania pakietu Rtools.
texa.
R CMD check [opcje] nazwapakietu - program sprawdza czy budowany pakiet jest
\encoding{} - ustala strone, kodowa,, np: cp1250, latin1, latin2. Jeśli zadeklarowany w poprawnie napisany, funkcje, zbiory danych, dokumentacje (testuje latex-em). Komunikuje
pliku DESCRIPTION, a nie w pliku .Rd, używa domyślnie tej strony kodowej dla calego ostrzeżenia o użyciu znaków spoza kodu ASCII. Instaluje pakiet w katalogu roboczym i tespakietu. W różnych kodowaniach różnie bed
, a, przedstawiane znaki. Możemy użyć polecenia tuje jego dzialanie.
\enc{}{}, jeśli kodowanie którego używamy pozwoli pokazać napis w pierwszym nawiasie, nazwapakietu musi być nazwa katalogu lub plikiem w formacie .tar.gz, .tar.bz2, .tgz.
,
wtedy sie, wyświetli, jeśli nie to zobaczymy slowo w kodzie ASCII, umieszczone w nawiasie opcje
obok, np:\enc{źródlany}{zrodlany}.
--help - wypisuje pomoc po czym kończy prace.
,
\name{} - nazwa pliku .Rd
--no-codoc - nie sprawdzaj dokumentacji.
\alias{} - haslo po którym w pisaniu w konsoli R po ?, uzyskamy informacje na temat tego
--no-examples - nie sprawdzaj przykladów.
obiektu. Dopuszczalne jest wiecej
niż
jedno
pole
tego
typu.
--no-manual - nie produkuj dokumentacji w pdf.
,
\docType{} - rodzaj obiektu, o którym piszemy dokumentacje. Jeśli jest to zbiór danych to
--no-install - tworzy prawie pusty podkatalog nazwapakietu.Rcheck.
data, dla funkcji to function.
--timings - tworzy plik .TIMINGS w którym zapisuje czas wykonywania wszystkich pro\title{} - tytul funkcji lub zbioru danych, najlepiej gdy nie przekracza 65 znaków.
cedur z pakietu (wynik funkcji Rprof()).
\description{} - krótki opis tego co zawiera dokumentacja.
R CMD build [opcje] nazwapakietu - buduje pakiet do pliku .tar.gz.
\usage{} - przykladowe użycie funkcji z nazwami jego wszystkich argumentów nazwapakietu nazwa budowanego pakietu.
fun(arg1,arg2,...).
opcje
\format{} - jedynie dla zbioru danych. Informacja o formacie zbioru danych, w jakim go za--help - wypisuje pomoc po czym kończy prace.
,
pisano np: matrix, dataframe, vector oraz ich rozmiar. Jeśli jest to ramka danych to możemy
--no-manual - nie buduj dokumentacji w pdf.
podać nazwy kolumn i wierszy.
R CMD INSTALL [opcje] nazwapakietu - instaluj pakiet do katalogu .libPaths() (domyśl\arguments{} - w dokumentacji funkcji, opis argumentów przyjmowanych przez procedure.
nie
jest to podkatalog library w lokalizacji programu R). Do użycia tej komendy potrzebny
,
Komenda \item{arg_i}{Opis arg_i.} wypunktowuje kolejne argumenty.
jest zainstalowany pakiet Rtools.
\details{} - rozszerzenie informacji zawartych w \description{}.
nazwapakietu nazwa archiwum zawierajacego
pakiet o rozszerzeniu .tar, tar.gz albo .zip.
,
\source{} - źródlo danych, można tu umieścić linki lub odnośniki do konkretnych stron z opcje
ksiażki.
--help - wypisuje pomoc po czym kończy prace.
,
,
\references{} - spis literatury tematycznej. Do umieszczenia linków stosujemy \url{} albo
--no-docs - nie instaluj dokumentacji HTML oraz latex.
\href{adres}{nazwa}.
--no-exec, --no-demo, --no-data, --no-help - pomija instalacje niektórych skladowych
\examples{} - przyklady użycia funkcji, kod wykonywany i pokazywany w konsoli. Polecenie pakietu.
\dontrun{} pokazuje, ale nie wykonuje kodu, \dontshow{} nie wykonuje, ale pokazuje kod. Tomasz Zmorzyński, Program R, 2011
\author{} - autor pakietu, adres email umieszczamy w \email{}.