Tytuł
U góry strony pomocy znajduje się tytuł, który mówi coś o funkcji (funkcjach). Na przykład dla funkcji lm () tytuł brzmi „Dopasowywanie modeli liniowych”.
Opis
Pod tytułem znajduje się opis sposobu użycia funkcji, pod nagłówkiem słowa „Opis”. Opis może być długi lub krótki, w zależności od złożoności funkcji. Dla funkcji lm () znajdziesz następujący opis:
„lm służy do dopasowania modeli liniowych. Może być wykorzystywany do przeprowadzania regresji, analizy pojedynczej warstwy wariancji i analizy kowariancji (chociaż aov może zapewnić bardziej dogodny interfejs dla nich). ”
Użycie
Sekcja „Użycie” znajduje się pod opisem. W sekcji „Użycie” wymieniono funkcję(-e) ze wszystkimi możliwymi argumentami funkcji. W przypadku argumentów z wartościami domyślnymi podane są wartości domyślne. W przypadku funkcji lm () sekcja „Użycie” zawiera następujące elementy:
lm (wzór, dane, podzbiór, wagi, na.action, method = “qr”,
model = PRAWDA, x = FAŁSZ, y = FAŁSZ, qr = PRAWDA,
singular.ok = PRAWDA, kontrasty = NULL, przesunięcie, …)
Argumenty z wartościami domyślnymi to argumenty, dla których argumenty zostały ustawione na wartość równą wartości.
Argumenty
Poniżej sekcji „Użycie” znajduje się sekcja zatytułowana „Argumenty”. W sekcji „Argumenty” argumenty znalezione w sekcji „Wykorzystanie” są wymienione wraz z opisem każdego argumentu. Opis zawiera wartości prawne argumentu. Na przykład na stronie pomocy lm () pierwsze dwa wymienione argumenty są następujące:
formula: obiekt klasy „formula” (lub taki, który można przymusić do tej klasy): symboliczny opis modelu, który ma zostać dopasowany. Szczegóły specyfikacji modelu podano w „Szczegóły”.
data: opcjonalna ramka danych, lista lub środowisko (lub obiekt koercyjny przez ramkę as.data do ramki danych) zawierający zmienne w modelu. Jeśli nie występują w danych, zmienne są pobierane ze środowiska (formuły), zwykle środowiska, z którego wywoływane jest lm.
Tak więc dla funkcji lm() pierwszy argument jest formułą, a drugi argument może być ramką data.frame, ale drugi argument jest opcjonalny.
Szczegóły
Czasami istnieje sekcja zatytułowana „Szczegóły”, która podaje szczegóły związane z argumentami. W przykładzie funkcji lm () sekcja ze szczegółami podaje zasady konfigurowania formuły i zachowania tej funkcji przy różnych wejściach do formuły.
Wartość
Następna sekcja nosi tytuł „Wartość”. Sekcja „Wartość” zawiera opis tego, co jest zwracane z funkcji. W przypadku niektórych funkcji, jakie funkcje mogą działać na wyjściu i jakie podzespoły można podzielić na dane wyjściowe, są istotne i wymienione w tej sekcji.
Pierwsze kilka wierszy sekcji „Wartość” dla funkcji lm() wygląda następująco:
lm zwraca obiekt klasy „lm” lub dla wielu odpowiedzi klasy c („mlm”, „lm”).
Funkcja summary i anova służą do uzyskania i wyświetleniaa podsumowania i analizy tabeli wariancji wyników. Ogólny moduł funkcyjny dopasowuje współczynniki, efekty. wartości i reszty wydzielają różne użyteczne cechy wartości zwracanej przez lm. Obiekt klasy „lm” to lista zawierająca co najmniej następujące elementy:
coefficients : nazwany wektor współczynników
residual : reszty, czyli odpowiedź minus dopasowane wartości. …
Niektóre inne sekcje opcjonalne
Po sekcji „Wartość” mogą znajdować się inne sekcje, w których podano więcej informacji. Dla funkcji lm() istnieją trzy inne sekcje: „Korzystanie z szeregów czasowych”, „Uwaga” i „Autor (autorzy)”. Niektóre sekcje dotyczące innych funkcji mogą być „Ostrzeżenie”, „Źródło” lub inne nagłówki.
Referencje
Kolejna sekcja nosi nazwę „Referencje”. Sekcja „Referencje” zawiera odniesienia do książek i artykułów związanych z metodą, zarówno w celu uzyskania dodatkowych informacji, jak i sposobu uzyskania metody.
Zobacz też
Sekcja „Zobacz też” następuje po sekcji „Referencje”. Sekcja „Zobacz też” zawiera informacje o innych funkcjach związanych z funkcjami strony pomocy. W przypadku funkcji lm () pierwsze trzy wiersze sekcji „Zobacz także” są następujące:
summary.lm dla podsumowań i anova.lm dla tabeli ANOVA; aov dla innego interfejsu.
Funkcje ogólne coef, effects, residuals, fitted, vcov..
predict.lm (przez prognozowanie) do przewidywania, w tym przedziały ufności i przewidywania; confint dla przedziałów ufności parametrów.
Sekcja „Zobacz także” jest dobrym źródłem wskazówek dotyczących funkcji związanych z metodą stosowaną przez użytkownika.
Przykłady
Ostatnia sekcja, którą ma większość stron, to „Przykłady”. W sekcji „Przykłady” podano przykłady użycia funkcji. Zobaczenie rzeczywistych przykładów użycia może być bardzo pomocne. Na stronie pomocy funkcji lm () część przykładu zawiera następujące elementy:
require(graphics)
## Annette Dobson (1990) “An Introduction to Generalized Linear Models”.
## Page 9: Plant Weight Data.
ctl <- c(4.17,5.58,5.18,6.11,4.50,4.61,5.17,4.53,5.33,5.14)
trt <- c(4.81,4.17,4.41,3.59,5.87,3.83,6.03,4.89,4.32,4.69)
group <- gl(2, 10, 20, labels = c(“Ctl”,”Trt”))
weight <- c(ctl, trt)
lm.D9 <- lm(weight ~ group)
lm.D90 <- lm(weight ~ group – 1) # omitting intercept
anova(lm.D9)
summary(lm.D90)
W tym przykładzie struktura formuły jest pokazana, a nie wyjaśniona. Pokazane są również niektóre funkcje, które działają na obiekcie klasy lm. Ponieważ grafika pakietu jest ładowana domyślnie, wywołanie wymagania (grafika) zwykle nie byłoby konieczne