TheknitrPaketti tarjoaa paljon lohkovaihtoehtoja lähes kaikkien koodipalojen osien, kuten lähdekoodin, tekstitulosteen, juonien ja kappaleen kielen, mukauttamiseen. Se tarjoaa myös joitain vaihtoehtoja pakettitasolla neulontaprosessin mukauttamiseen. Tällä sivulla dokumentoidaan kaikki saatavilla olevat lohkovaihtoehdot ja pakettivaihtoehdotknitr. Näiden vaihtoehtojen oletusarvot ovat suluissa luettelokohdissa.
Osion asetukset
Osavaihtoehdot kirjoitetaan kappaleen otsikoihin. Osaotsikoiden syntaksi riippuu asiakirjan muodosta, esim. for.Rnw
asiakirjat (R + LaTeX), osien otsikot kirjoitetaan<< >>=
, ja varten.Rmd
asiakirjat, kappaleen otsikot kirjoitetaan``` {r}
. Alla olevat esimerkit ovat ensisijaisesti tarkoitettuja.Rmd
asiakirjoja (RMarkdown), mutta useimmissa tapauksissa lohkovaihtoehtoja voidaan käyttää minkä tahansa asiakirjamuodon kanssa.
Osavaihtoehdot on kirjoitettu lomakkeeseentag=arvo
kuten tämä:
```{r, my-chunk, echo=FALSE, fig.height=4, dev='jpeg'}```
Erityinen kappalevaihtoehto on kappaleen etiketti (esim.minun palani
yllä olevassa esimerkissä). Vain osan etiketti ei tarvitse atag
(eli annat vainarvo
). Jos pidät lomakkeestatag=arvo
, voit myös käyttää chunkoptiotaetiketti
nimenomaisesti, esim.
```{r, label='my-chunk'}```
Jokaisen palatunnisteen oletetaan olevan yksilöllinen asiakirjassa. Tämä on erityisen tärkeää välimuisti- ja plot-tiedostonimille, koska nämä tiedostonimet perustuvat lohkotunnisteisiin. Palloille, joissa ei ole tunnisteita, määritetään tunnisteet, kutenunnamed-chunk-i
, missäi
on inkrementaalinen luku.
Voit käyttääknitr::opts_chunk$set()
muuttaaksesi asiakirjan chunkoption oletusarvoja. Voit esimerkiksi laittaa tämän asiakirjasi ensimmäiseen koodiosaan:
```{r, setup, include=FALSE}knitr::opts_chunk$set( comment = '', fig.width = 6, fig.height = 6)```
Alla on vielä muutama vinkki lohkovaihtoehdoista:
Kappaleen otsikko on kirjoitettava yhdelle riville. Rajaa ei saa rikkoa.
Yritä välttää välilyöntejä, pisteitä (
.
), ja alaviivat (_
) kappaletunnisteissa ja poluissa. Jos tarvitset erottimia, on suositeltavaa käyttää väliviivoja (-
)sen sijaan. Esimerkiksi,asetusvaihtoehdot
on hyvä etiketti, kun taassetup.options
japala 1
ovat pahoja;fig.path = 'figures/mcmc-'
on hyvä polku kuvion tuottamiseen, jafig.path = 'markovin ketju/monte carlo'
on paha.Kaikkien vaihtoehtojen arvojen on oltavakelvollisia R-lausekkeita. Voit ajatella niitä arvoina, jotka välitetään funktion argumenteille.
- Esimerkiksi vaihtoehdot, jotka kestävätmerkkiarvot tulee lainata, esim.
tulokset = 'asis'
jaout.width = '\\textwidth'
(muista, että aliteraalinen kenoviiva vaatii kaksinkertaista kenoviivaa). - Teoriassa myös kappaleen etiketti tulisi lainata. Mukavuuden vuoksi se lainataan kuitenkin automaattisesti, jos et ole (esim.
``` {r, 2a}
jäsennetään nimellä```{r, '2a'}
). - Voit kirjoittaa mielivaltaisesti monimutkaisia lausekkeita, kunhan ne ovat kelvollista R-koodia.
- Esimerkiksi vaihtoehdot, jotka kestävätmerkkiarvot tulee lainata, esim.
Vaihtoehtoisesti voit kirjoittaa lohkovalinnat koodikappaleen tekstiosan jälkeen#|
, esim.,
```{r}#| my-chunk, echo = EPÄTOSI, fig.width = 10,#| fig.cap = "Tämä on pitkä long#| pitkä pitkä kuvateksti."plot(cars)```
Tätä syntaksia varten on kirjoitettava kappalevalinnatjatkuvarivit (eli kaikkien rivien täytyy alkaa erityisellä kommentin etuliitteellä, kuten#|
) palarungon alussa. Tyhjä rivi vaihtoehtojen ja koodin välillä on valinnainen. Tämä syntaksi mahdollistaa vaihtoehtojen tiivistyksen. Voit jakaa vaihtoehdot niin monelle riville kuin haluat. Jos sama vaihtoehto on tarjolla sekä kappaleen rungossa että kappaleen otsikossa (sisällä```{}
), edellinen ohittaa jälkimmäisen. Voit myös käyttää YAML-syntaksia vaihtoehtojen kirjoittamiseen lomakkeen osaantag: arvo
. Normaalisti sinun on annettava vain yksi vaihtoehto riviä kohden, esim.
```{r}#| echo: false#| kuvan leveys: 10```
Jos päätät käyttää YAML-syntaksia, asetusarvojen on oltava kelvollisia YAML-arvoja raaka-R-lausekkeiden sijaan.
Alla on luettelo lohkovaihtoehdoistaknitrdokumentoitu muodossa"vaihtoehto
:(oletusarvo
; arvotyyppi)”.
Koodin arviointi
eval
:(TOTTA
; looginen vai numeerinen) Arvioidaanko koodipala. Se voi olla myös numeerinen vektori, jolla valitaan mitkä R-lausekkeet arvioidaan, esim.eval = c(1, 3, 4)
arvioi ensimmäisen, kolmannen ja neljännen lausekkeen jaeval = -(4:5)
arvioi kaikki lausekkeet paitsi neljäs ja viides.
Tekstin tulostus
kaiku
:(TOTTA
; looginen vai numeerinen) Näytetäänkö lähdekoodi tulosdokumentissa. sitä paitsiTOTTA
/VÄÄRÄ
, joka näyttää/piilottaa lähdekoodin, voimme myös käyttää numeerista vektoria valitaksesi mitkä R-lausekkeet kaikuvat palassa, esim.kaiku = 2:3
tarkoittaa toistaa vain 2. ja 3. ilmaisu, jakaiku = -4
tarkoittaa neljännen lausekkeen sulkemista pois.tuloksia
:("merkintä"
; merkki) Ohjaa tekstitulosten näyttämistä. Huomaa, että tämä vaihtoehto koskee vain normaalia tekstitulostusta (ei varoituksia, viestejä tai virheitä). Mahdolliset arvot ovat seuraavat:merkintä
: Merkitse tekstitulostus sopivilla ympäristöillä tulostusmuodon mukaan. Esimerkiksi R Markdown, jos tekstituloste on merkkijono"[1] 1 2 3"
, todellinen tulosknitrtuottaa tulee olemaan:``` [1] 1 2 3```
Tässä tapauksessa,
tulokset='markup'
tarkoittaa tekstin sijoittamista aidattuihin koodilohkoihin (```
).kuten on
: Kirjoita tekstituloste sellaisenaan, eli kirjoita raakatekstitulokset suoraan tulostedokumenttiin ilman merkintöjä.```{r, results='asis'}cat("Olen raakaa **Markdown** sisältöä.\n")```
pidä
: Pidä kaikki tulostettavan tekstin osat lohkossa ja huuhtele ne kappaleen loppuun asti.piilottaa
(taiVÄÄRÄ
): Piilota tekstituloste.
romahdus
:(VÄÄRÄ
; looginen) Jos mahdollista, tiivistetäänkö kaikki lähde- ja lähtölohkot yhdestä koodipalasta yhdeksi lohkoksi (oletusarvoisesti ne kirjoitetaan erillisiin lohkoihin). Tämä vaihtoehto koskee vain Markdown-asiakirjoja.Varoitus
:(TOTTA
; looginen) Säilytetäänkö varoitukset (tuottajaVaroitus()
) tulosteessa.Jos
VÄÄRÄ
, kaikki varoitukset estetään.Jos
ETTÄ
, varoituksia ei tallenneta ja ne tulostetaan oletuksena konsoliin.Tämä vaihtoehto voi myös käyttää numeerisia arvoja indekseinä valitakseen varoitusten osajoukon, jotka sisällytetään tulosteeseen. Huomaa, että nämä arvot viittaavat itse varoitusten indekseihin (esim.
3
tarkoittaa "kolmatta varoitusta, joka on heitetty tästä palasta" eikä sen indeksit, joiden lausekkeet saavat lähettää varoituksia.
viesti
:(TOTTA
; looginen) Säilytetäänkö käyttäjän lähettämät viestitviesti()
(samanlainen kuin vaihtoehtoVaroitus
).virhe
:(TOTTA
; looginen) Säilytetäänkö virheet (alkaenlopettaa()
). Oletuksena koodin arviointi ei pysähdy edes virheiden sattuessa! Jos haluamme lopettaa virheiden, meidän on asetettava tämä vaihtoehtoVÄÄRÄ
. Huomaa, että RMarkdown on muuttanut tämän oletusarvonVÄÄRÄ
. Kun palavaihtoehtosisällyttää = EPÄTOSI
,knitrpysähtyy virheen sattuessa, koska tässä tapauksessa on helppo jättää huomiotta mahdolliset virheet. Jos ymmärrät tämän varoituksen ja haluat käsitellä mahdolliset virheet itse, voit määrittäävirhe
numeroarvoihin, sellaisina kuin ne on määriteltyarvioida::evaluate()
:0
jatkaa arviointia virheiden jälkeen ikään kuin olisit liittänyt tekstin terminaaliin;1
lopettaa arvioinnin virheen jälkeen, mutta päättyy sitten normaalisti (käsittele virheet manuaalisesti, voit käyttäävirhekoukku);2
ilmoittaa virheistä normaalisti (eli pysäyttää R:n).
sisältää
:(TOTTA
; looginen) Määrittää, sisällytetäänkö osatulostus tulostusasiakirjaan. JosVÄÄRÄ
, tulosdokumenttiin ei kirjoiteta mitään, mutta koodi arvioidaan silti ja piirrostiedostot luodaan, jos kappaleessa on piirroksia, joten voit lisätä numeroita manuaalisesti myöhemmin.tab.cap
:(TYHJÄ
; merkki) Kuvateksti forkaapeli()
koodikappaleessa. Jotta tämä osavaihtoehto toimisi, yhdessä koodikappaleessa on oltava vain yksikaapeli()
puhelu.nauha.valkoinen
:(TOTTA
; looginen) Poistetaanko tyhjät rivit tulosteen lähdekoodilohkon alusta vai lopusta.class.output
:(TYHJÄ
; merkki) Luokkien nimien vektori, joka lisätään tekstin tulostuslohkoihin. Tämä vaihtoehto toimii vain RMarkdownin HTML-tulostusmuodoissa. Esimerkiksi kanssaclass.output = c('foo', 'bar')
, tekstituloste sijoitetaan sisään.
luokka.viesti
/luokka.varoitus
/class.error
:(TYHJÄ
; merkki) Samanlainen kuinclass.output
, mutta sitä sovelletaan RMarkdown-tulosteen viesteihin, varoituksiin ja virheisiin. Katso "Koodin koristelu" -osiossaclass.source
, joka koskee samalla tavalla lähdekoodilohkoja.attr.output
/attr.message
/attr.warning
/attr.error
:(TYHJÄ
;merkki) Samanlainen kuinluokka.*
yllä olevat vaihtoehdot, mutta Pandocin mielivaltaisten aidattujen koodilohkojen määritteiden määrittämiseen;luokka.*
on erityinen sovellusattr.*
, esim.,class.source = 'numerorivit'
on vastaavaattr.source = '.numberLines'
, muttaattr.source
voi ottaa mielivaltaisia attribuuttiarvoja, esim.attr.source = c('.numberLines', 'startFrom="11"')
.renderöidä
:(knitr::knit_print
;funktio (x, valinnat, ...)
) Funktio, joka tulostaa näkyvät arvot paloina. Arvo, joka välitetään tämän funktion ensimmäiselle argumentille (ts.x
) on osan kustakin lausekkeesta arvioitu arvo. Nykyisten kappalevaihtoehtojen luettelo välitetään argumentillevaihtoehtoja
. Tämän funktion odotetaan palauttavan merkkijonon. Lisätietoja on paketin vinjetissä mukautetun kappaleen renderöinnistä:vinjetti('knit_print', package = 'knitr')
.jakaa
:(VÄÄRÄ
; looginen) Jaa tulos erillisiin tiedostoihin ja sisällytetäänkö ne LaTeXiin by\input{}
tai HTML by. Tämä vaihtoehto toimii vain
.Rnw
,.Rtex
, ja.Rhtml
asiakirjoja.
Koodin koristelu
siisti
:(VÄÄRÄ
) Aloittaako R-koodi uudelleen. Muita mahdollisia arvoalueita ovat seuraavat:TOTTA
(vastaasiisti = 'formatR'
): Kutsu funktioformatR::tidy_source()
muotoilla koodi uudelleen."styler"
: Käytästyler::style_text()
muotoilla koodi uudelleen.- Lomakkeen mukautettu toiminto
funktio(koodi, ...) {}
palauttaaksesi muotoillun koodin. - Jos alustaminen epäonnistuu, alkuperäinen R-koodi ei muutu (varoituksella).
siisti.opts
:(TYHJÄ
; lista) Luettelo vaihtoehdoista, jotka välitetään toiminnon määrittämälle toiminnollesiisti
vaihtoehto, esim.tidy.opts = lista (tyhjä = EPÄTOSI, leveys.cutoff = 60)
vartensiisti = 'formatR'
poistaaksesi tyhjät rivit ja yrittää leikata koodirivit 60 merkin pituiseksi.kehote
:(VÄÄRÄ
; looginen) Määrittää, lisätäänkö kehotemerkit Rkoodiin. Katsokehote
jajatkaa
ohjesivulla?base::optiot
. Huomaa, että kehotteiden lisääminen voi vaikeuttaa lukijoiden R-koodin kopioimista lähdöstä, jotenkehote = EPÄTOSI
voi olla parempi valinta. Tämä vaihtoehto ei ehkä toimi hyvin, kun chunk-vaihtoehtomoottori
ei oleR
(#1274).kommentti
:('##'
; merkki) Etuliite, joka lisätään ennen jokaista tekstitulosteen riviä. Oletusarvoisesti tekstitulostusta kommentoi##
, joten jos lukijat haluavat kopioida ja suorittaa lähdekoodin tulostedokumentista, he voivat valita ja kopioida kaiken kappaleesta, koska tekstitulostus on peitetty kommenteissa (ja jätetään huomiotta kopioitua tekstiä suoritettaessa). Asetakommentti =''
poista oletusarvo##
.kohokohta
:(TOTTA
; looginen) Määrittää, korostetaanko lähdekoodi syntaksia.class.source
: (NULL; merkki) Luokkanimet lähdekoodilohkoille tulosteasiakirjassa. Samanlainen kuinluokka.*
tulostusvaihtoehdot, kutenclass.output
.attr.source
:(TYHJÄ
; merkki) Lähdekoodilohkojen attribuutit. Samanlainen kuinattr.*
tulostusvaihtoehdot, kutenattr.output
.lang
:(TYHJÄ
; merkki) Koodipalan kielinimi. Oletusarvoisesti kielen nimi on moottorin nimi, esim.r
. Tämä vaihtoehto on tarkoitettu ensisijaisesti Markdown-pohjaisten tulosteiden syntaksin korostamiseen.koko
:('normaali koko'
; merkki) osoitteesta tulostettavan kappaleen fonttikoko.Rnw
asiakirjoja. Katsotämä sivumahdollisille kokoille.tausta
:('#F7F7F7'
; merkki) Kappaleen tulosteen taustaväri.Rnw
asiakirjoja.sisennys
: (merkki) Merkkijono, joka lisätään jokaiselle osatulosteen riville. Tyypillisesti se koostuu välilyönneistä. Tämän vaihtoehdon oletetaan olevan vain luku, jaknitrasettaa arvon dokumenttia jäsentäessään. Esimerkiksi alla oleva osasisennys
on merkkijono, jossa on kaksi välilyöntiä:```{r}rnorm(10)```
Kätkö
kätkö
:(VÄÄRÄ
; looginen) Tallennetaanko koodipala välimuistiin. Arvioitaessa koodipaloja toisen kerran välimuistissa olevat palaset ohitetaan (ellei niitä ole muokattu), mutta näissä paloissa luodut objektit ladataan aiemmin tallennetuista tietokannoista (.rdb
ja.rdx
tiedostot), ja nämä tiedostot tallennetaan, kun kappaletta arvioidaan ensimmäisen kerran tai kun välimuistissa olevia tiedostoja ei löydy (esimerkiksi olet saattanut poistaa ne käsin). Huomaa, että tiedostonimi koostuu osatunnisteesta, jossa on R-koodin MD5-tiivistelmä ja koodiosan osien vaihtoehdot, mikä tarkoittaa, että kaikki muutokset osaan tuottavat erilaisen MD5-tiivisteen ja näin ollen mitätöivät välimuistin. Katso lisätietojatämä sivu.cache.path
:('kätkö/'
; merkki) Etuliite, jota käytetään luomaan välimuistitiedostojen polut. R Markdownin oletusarvo perustuu syöttötiedoston nimeen, esim. tunnisteella varustetun kappaleen välimuistipolkuihinFOO
tiedostossaINPUT.Rmd
tulee olemaan muotoaINPUT_cache/FOO_*.*
.cache.vars
:(TYHJÄ
; merkki) Muuttujien nimien vektori, joka tallennetaan välimuistitietokantaan. Oletusarvoisesti kaikki nykyiseen lohkoon luodut muuttujat tunnistetaan ja tallennetaan, mutta voit halutessasi määrittää tallennettavat muuttujat manuaalisesti, koska muuttujien automaattinen tunnistus ei välttämättä ole luotettavaa, tai saatat haluta tallentaa vain osan muuttujista.cache.globals
:(TYHJÄ
; merkki) Niiden muuttujien nimien vektori, joita ei ole luotu nykyisestä osasta. Tämä vaihtoehto on tarkoitettu pääasiassaautodep = TOSI
toimimaan tarkemmin – palaB
riippuu palastaA
kun jokinB
globaalit muuttujat ovatA
paikalliset muuttujat. Jos globaalien muuttujien automaattinen havaitseminen (eli milloincache.globals = NULL
taiTOTTA
) jos kappale epäonnistuu, voit määrittää globaalien muuttujien nimet manuaalisesti tällä vaihtoehdolla (katso#1403esimerkiksi). Lisäksi,cache.globals = EPÄTOSI
tarkoittaa kaikkien koodilohkon muuttujien havaitsemista riippumatta siitä, ovatko ne globaaleja vai paikallisia muuttujia.välimuisti.laiska
:(TOTTA
; looginen) onkolazyLoad()
tai suoraanladata()
esineitä. Erittäin suurilla esineillä laiskalataus ei ehkä toimi, jotencache.lazy = EPÄTOSI
voi olla toivottavaa (katso#572).cache.comments
:(TYHJÄ
; looginen) JosVÄÄRÄ
, kommenttien muuttaminen R-koodipaloissa ei mitätöi välimuistitietokantaa.cache.rebuild
:(VÄÄRÄ
; looginen) JosTOTTA
, arvioi pala uudelleen, vaikka välimuistia ei tarvitsisi mitätöidä. Tästä voi olla hyötyä, kun haluat ehdollisesti mitätöidä välimuistin, esim.cache.rebuild = !file.exists("joku tiedosto")
voi rakentaa palan uudelleen kunjokin tiedosto
ei ole olemassa (katso#238).riippuu
:(TYHJÄ
; merkki tai numeerinen) Osamerkkien merkkivektori, joka määrittää, mistä muista paloista tämä osa riippuu. Tämä vaihtoehto koskee vain välimuistissa olevia osia – joskus välimuistissa olevan kappaleen objektit voivat riippua muista välimuistissa olevista paloista, joten kun muita osia muutetaan, tämä osa on päivitettävä vastaavasti.- Jos
riippuu
on numeerinen vektori, se tarkoittaa kappaletunnisteiden indeksejä, esim.riippuu = 1
tarkoittaa, että tämä osa riippuu asiakirjan ensimmäisestä osasta jariippuu = c(-1, -2)
tarkoittaa, että se riippuu kahdesta edellisestä palasta (negatiiviset indeksit tarkoittavat tätä osaa edeltävien kappaleiden lukumäärää, ja huomaa, että ne ovat aina suhteessa nykyiseen palaan). - Huomaa, että tämä vaihtoehto ei toimi, kun se on asetettu globaaliksi kappalevaihtoehdoksi
opts_chunk$set()
; se on asetettava paikalliseksi osavaihtoehdoksi.
- Jos
autodep
:(VÄÄRÄ
; looginen) Analysoidaanko paloiden väliset riippuvuudet automaattisesti havaitsemalla globaalit muuttujat koodissa (ei ehkä ole luotettava), jotenriippuu
ei tarvitse erikseen määrittää.
Tontteja
fig.path
:('kuvio/'
; merkki) Etuliite, jota käytetään luomaan kuvatiedostopolut.fig.path
ja lohkotunnisteet ketjutetaan luomaan kaikki polut. Se voi sisältää hakemiston, kutenluku/etuliite-
; hakemisto luodaan, jos sitä ei ole olemassa.fig.keep
:('korkea'
; merkki) Kuinka palaset tulee säilyttää. Mahdolliset arvot ovat seuraavat:korkea
: Säilytä vain korkean tason kuvaajia (yhdistä matalan tason muutokset korkean tason kuvaajiin).ei mitään
: Hylkää kaikki kuviot.kaikki
: Säilytä kaikki kaaviot (matalan tason kaaviomuutokset voivat tuottaa uusia kuvaajia).ensimmäinen
: Säilytä vain ensimmäinen juoni.kestää
: Säilytä vain viimeinen juoni.- Jos asetetaan numeeriseksi vektoriksi, arvot ovat (matalan tason) kaavioiden indeksejä säilytettäväksi.
Matalan tason piirtokomennot sisältävät
rivit()
japisteet()
jne. Ymmärtääksesi paremminfig.keep
, harkitse seuraavaa osaa:" yksi R-lauseke)for(i 1:10) { abline(v = i, lty = 2)}```
Normaalisti tämä tuottaa tulokseen 2 kuvaajaa (koska
fig.keep = 'korkea'
).Silläfig.keep = 'ei mitään'
, tontteja ei tallenneta. vartenfig.keep = 'kaikki'
, 4 tonttia on tallennettu. vartenfig.keep = 'ensimmäinen'
, juonen tuottamajuoni (1)
hävinnyt. vartenfig.keep = 'viimeinen'
, viimeinen kuvaaja, jossa on 10 pystysuoraa viivaa.fig. show
:('kuten on'
; hahmo) Kuinka näyttää/järjestää juonet. Mahdolliset arvot ovat seuraavat:kuten on
: Näytä kaaviot tarkalleen paikoissa, joissa ne on luotu (ikään kuin koodia ajettaisiin R-päätteessä).pidä
: Pidä kaikki kaaviot ja tulosta ne koodikappaleen lopussa.animoida
: Liitä kaikki juonit animaatioksi, jos osassa on useita juovia.piilottaa
: Luo juonitiedostoja, mutta piilota ne tulosasiakirjassa.
kehittäjä
:('pdf'
LaTeX-ulostulolle ja'png'
HTML/Markdown; merkki) Graafinen laite juonitiedostojen luomiseen. Kaikki näytönohjaimet pohjassa Ranta ne sisäänKairo,svglite,miehet, jatikzDeviceovat tuettuja mm.pdf
,png
,svg
,jpeg
,tiff
,kairo_pdf
,KairoJPEG
,KairoPNG
,svglite
,gridSVG
,ragg_png
,tiktok
, ja niin edelleen. Katsonimet(neule:::auto_exts)
koko listalle. Näiden laitteiden lisäksi voit antaa myös merkkijonon, joka on lomakkeen funktion nimifunktio (tiedoston nimi, leveys, korkeus)
. Kuvan koon yksiköt ovatainatuumaa (jopa bittikarttalaitteissa, joissa DPI:tä käytetään pikselien ja tuuman muuntamiseen).Osavaihtoehdot
kehittäjä
,fig.ext
,fig.width
,fig.korkeus
, jadpi
canbe-vektoreita (lyhyemmät kierrätetään), ja ne vektorisoidaan jokaisen yksittäisen kaavion päälle koodikappaleessa useiden kopioiden luomiseksi samasta kaaviosta. Esimerkiksi,dev = c('pdf', 'png')
luo PDF- ja PNG-tiedoston samalle tontille. Huomaa, että kun luotavilla juonitiedostoilla on sama tiedostopääte, sinun on käytettäväfig.ext
vaihtoehto määrittää erilaisia tiedostonimien liitteitä, muuten jälkimmäiset juonitiedostot korvaavat aiemmat. Esimerkiksi milloindev = 'png'
jafig.width = c(10, 6)
, voit luoda kaksi eri levyistä PNG-kuvaafig.ext = c('1.png', '2.png')
.dev.args
:(TYHJÄ
; lista) Laitteelle välitettävät lisäargumentit, esim.dev.args = lista(bg = 'keltainen', pistekoko = 10)
vartendev = 'png'
. Tämä vaihtoehto riippuu tietystä laitteesta (katso laitteen dokumentaatio). Kunkehittäjä
sisältää useita laitteita,dev.args
voi olla luettelo argumenttiluetteloista, ja jokainen argumenttiluettelo välitetään jokaiselle yksittäiselle laitteelle, esim.dev = c('pdf', 'tiff'), dev.args = lista(pdf = lista(värimalli = 'cmyk', useDingats = TOSI), tiff = lista(pakkaus = 'lzw'))
.fig.ext
:(TYHJÄ
; merkki) Kuvatulosteen tiedostopääte. JosTYHJÄ
, se johdetaan graafisesta laitteesta; katsoknitr:::auto_exts
yksityiskohtia varten.dpi
:(72
; numeerinen) DPI (dots per inch) bittikarttalaitteiden (dpi * tuumaa = pikseliä
).fig.width
,fig.korkeus
: (molemmat ovat7
; numeerinen) Piirin leveys ja korkeus (tuumina), joita käytetään grafiikkalaitteessa.fig.asp
:(TYHJÄ
; numeerinen) Kuvaajan kuvasuhde, eli korkeuden/leveyden suhde. Kunfig.asp
on määritetty, kuvaajan korkeus (palavaihtoehtofig.korkeus
) lasketaan alkaenfig.width * fig.asp
.fig.dim
:(TYHJÄ
; numeerinen) Numeerinen vektori, jonka pituus on 2fig.width
jafig.korkeus
, esim.,fig.dim = c(5, 7)
on lyhenne sanastakuva leveys = 5, kuva korkeus = 7
. Jos molemmatfig.asp
jafig.dim
tarjotaan,fig.asp
ohitetaan (varoituksella).ulos.leveys
,ulos.korkeus
:(TYHJÄ
; merkki) Tulostedokumentin plotin leveys ja korkeus, jotka voivat vaihdella fyysisestifig.width
jafig.korkeus
, eli tulosteet voidaan skaalata tulosdokumentissa. Näillä kahdella vaihtoehdolla voi olla erityisiä arvoja tulostusmuodosta riippuen. Esimerkiksi LaTeX-tulostuksessa ne voivat olla.8\\linjanleveys
,3 tuumaa
, tai8 cm
;HTML:lle ne voivat olla300 pikseliä
. varten.Rnw
asiakirjat, oletusarvoulos.leveys
muutetaan muotoon\\maxwidth
, joka on määriteltytällä sivulla.Se voi olla myös prosenttiosuus, esim."40%"
käännetään kielelle0,4\linjanleveys
kun tulostusmuoto on LaTeX.out.extra
:(TYHJÄ
; merkki) Lisäasetukset hahmoille. Se voi olla mielivaltainen merkkijono, joka voidaan lisätä\includegraphics[]
LaTeX-lähdössä (esim.out.extra = 'kulma=90'
kääntääksesi kuvaa 90 astetta), taiHTML-ulostulossa (esim.
out.extra = 'style="border:5px solid orange;"'
).kuva verkkokalvo
:(1
; numeerinen) Tämä vaihtoehto koskee vain HTML-tulostusta. vartenRetina näytöt,tämän vaihtoehdon asettaminen suhteeksi (yleensä 2) muuttaa kappalevaihtoehtoadpi
todpi * fig.retina
, jaulos.leveys
tofig.width * dpi / fig.retina
sisäisesti. Esimerkiksi kuvan fyysinen koko kaksinkertaistuu ja sen näyttökoko puolitetaan, kunkuva.verkkokalvo = 2
.resize.width
,resize.height
:(TYHJÄ
; merkki) käytettävä leveys ja korkeus\resizebox{}{}
LaTeX-lähdössä. Näitä kahta vaihtoehtoa ei tarvita, ellet halua muuttaa TikZ-grafiikan kokoa, koska siihen ei ole luonnollista tapaa. Kuitenkin mukaantikzDeviceTekijät, TikZgraphicsin kokoa ei ole tarkoitettu muutettavaksi, jotta se säilyttää tyylin johdonmukaisuuden LaTeX:n muun tekstin kanssa. Jos vain yksi niistä onTYHJÄ
,!
käytetään (lue dokumentaatiographicxjos et ymmärrä tätä).fig.align
:('oletus'
; merkki) Tulosdokumentin kuvien kohdistus. Mahdolliset arvot ovatoletuksena
,vasemmalle
,oikein
, jakeskusta
. Oletuksena ei tehdä kohdistussäätöjä.fig.link
:(TYHJÄ
; merkki) Linkki, joka lisätään kuvaan.fig.env
:('hahmo'
; merkki) LaTeX-ympäristö kuvioille, esim. voit asettaafig.env = 'marginfigure'
saada\begin{marginfigure}
. Tämä vaihtoehto edellyttääfig.cap
täsmennettävä.fig.cap
:(TYHJÄ
; merkki) Kuvateksti.fig.alt
:(TYHJÄ
; merkki) Vaihtoehtoinen teksti, jota käytetäänalt
attribuuttilukujen tagit HTML-tulostuksessa. Oletuksena palavaihtoehto
fig.cap
käytetään vaihtoehtoisena tekstinä, jos tarjotaan.fig.scap
:(TYHJÄ
; merkki) Lyhyt kuvateksti. Tämä vaihtoehto on merkityksellinen vain LaTeX-ulostulolle. Siihen on lisätty lyhyt kuvateksti\caption[]
, ja näytetään yleensä PDF-dokumentin "Kuvaluettelossa".fig.lp
:('kuva:'
; merkki) Tarran etuliite kuvatarralle, johon lisätään\label{}
. Varsinainen etiketti tehdään yhdistämällä tämä etuliite ja osatunniste, esim.``` {r, juoni}
tulee olemaanfig:foo-plot
oletuksena. Huomaa, että lisääminen\label{}
riippuu siitä, kuinka kappale hahmonnetaan LaTeX-muodossa (katsotästä asiasta).fig.id
:(TYHJÄ
; looginen) MilloinTOTTA
, automaattiset tunnukset määritetään kuville, jotka on luotu koodipaloista R Markdownissa, eli kuvat kirjoitetaan HTML-koodilla, kuten. Oletustunnus koostuu
fig.lp
(etuliite),etiketti
(palatarra) jafig.cur
(nykyisen luvun numero kappaleessa). Kaikki ei-aakkosnumeeriset merkit tunnuksessa korvataan viivoilla, esim.'fig:hei maailma 1'
tulee'fig-hello-world-1'
. Vaihtoehtoisesti käyttäjät voivat tarjota toiminnon tunnuksen luomiseksi. Funktio ottaa syötteeksi luettelon nykyisistä lohkovaihtoehdoista ja sen pitäisi palauttaa merkkijono, esim.fig.id = function(optiot) { paste0('img-', options$label, options$fig.cur) }
.fig.pos
:(''
; merkki) Merkkijono käytettävälle kuvion sijaintijärjestelylle\begin{figure}[]
.fig.subcap
:(TYHJÄ
) Alakuvien kuvatekstit. Kun osassa on useita tontteja, eikä kumpaakaanfig.subcap
ei myöskäänfig.cap
OnTYHJÄ
,\subfloat{}
käytetään yksittäisille tonteille (sinun on lisättävä\usepackage{subfig}
johdannossa). Katso067-grafiikka-asetukset.Rnwesimerkkiä varten.fig.ncol
:(TYHJÄ
; kokonaisluku) Osalukujen sarakkeiden lukumäärä; katsotästä asiastaesimerkkejä varten (huomaa sefig.ncol
jafig.sep
toimii vain LaTeXoutputissa).fig.sep
:(TYHJÄ
; merkki) Erotinten merkkivektori, joka lisätään alihahmojen joukkoon. Kunfig.ncol
on määritelty,fig.sep
oletuksena merkkivektori, jonka jokainen N:s elementti on\uusi rivi
(missäN
on sarakkeiden lukumäärä), esim.fig.ncol = 3
tarkoittaafig.sep = c('', '', '\\uusi rivi', '', '', '\\uusi rivi', '', ...)
. Thei-erotin lisätään perääni-th alaluku, paitsi jos pituusfig.sep
on suurempi kuin alilukujen lukumäärä, jolloin ensimmäinenfig.sep
elementti lisätään ennen ensimmäistä alikuvaa, ja (i+1)-elementti lisätään perääni- alahahmo.fig.process
:(TYHJÄ
; Funktio) Figuuritiedostojen jälkikäsittelytoiminto. Sen tulee kulkea kuviotiedoston polkua ja palauttaa tulosteeseen lisättävän kuvan (uusi) polku. Jos funktio sisältäävaihtoehtoja
argumenttia, lohkovaihtoehtojen luettelo siirretään tälle argumentille.fig.showtext
:(TYHJÄ
; looginen) JosTOTTA
, puhelushowtext::showtext_begin()
ennen juonien piirtämistä. Katso dokumentaatioshowtekstipaketti yksityiskohtiin.ulkoinen
:(TOTTA
; looginen) Ulkoistaako tikz-grafiikka (esikääntää tikz-grafiikka PDF-muotoon). Sitä käytetään vaintickz()
laitteessatikzDevicepaketti (eli milloindev='tikz'
), ja se voi säästää aikaa LaTeX-kääntämisessä.puhdistaa
:(VÄÄRÄ
; merkki) Sanotaanko tikz-grafiikka (paeta LaTeX-erikoismerkit). Katso dokumentaatiotikzDevicepaketti.
On kaksi piilotettua vaihtoehtoa, joita ei ole suunniteltu käyttäjien asetettaviksi:fig.cur
(nykyisen kuvan numero tai indeksi, kun lukuja on useita), jakuva nro
(lukujen kokonaismäärä palassa). Näiden kahden vaihtoehdon tarkoitus on auttaaknitrkäsitellä useiden hahmojen tiedostonimiä sekä animaatioita. Joissakin tapauksissa voimme käyttää niitä animaatioiden kirjoittamiseen tuotteeseen käyttämällä juonitiedostoja, jotka tallennetaan manuaalisesti (katsograafinen käsikirjaesimerkeiksi).
Animaatio
intervalli
:(1
; numeerinen) Aikaväli (sekuntien lukumäärä) animaatiokehysten välillä.animaatio.koukku
:(knitr::hook_ffmpeg_html
; funktio tai merkki) Koukkufunktio animaatioiden luomiseksi HTML-tulostukseen; oletuskoukku käyttää FFmpeg:tä kuvien muuntamiseen WebM-videoksi.Toinen koukkutoiminto on
knitr::hook_gifski
perustuugifskipaketti GIF-animaatioiden luomiseen.Tämä vaihtoehto voi sisältää myös merkkijonon
"ffmpeg"
tai"gifski"
vastaavan koukkutoiminnon lyhenteenä, esim.animation.hook = 'gifski'
tarkoittaaanimation.hook = knitr::hook_gifski
.aniopts
:("säätimet, silmukka"
; merkki) Lisäasetukset animaatioille; katso LaTeXin dokumentaatioanimoidapaketti.
ffmpeg.bitrate
(1 milj
; merkki) välitetään-b:v
FFmpeg-argumentti WebM-videoiden laadun hallitsemiseksi.ffmpeg.format
(webm
; merkki) FFmpeg-videomuoto, eli videon tiedostopääte.
Koodipala
koodi
:(TYHJÄ
; merkki) Jos se on annettu, se ohittaa koodin nykyisessä osassa. Tämä antaa meille mahdollisuuden lisätä ohjelmallisesti koodia nykyiseen osaan. Esimerkiksi,koodi = readLines('test.R')
käyttää tiedoston sisältöätesti.R
nykyisen osan koodina.tiedosto
:(TYHJÄ
; merkki) Jos annetaan, se ohittaakoodi
vaihtoehto lukemalla osan sisältö ulkoisista tiedostoista. Osittainen vaihtoehtotiedosto = "testi.R"
on vastaavakoodi = xfun::read_all("test.R")
.ref.label
:(TYHJÄ
; merkki) Merkkivektori niiden kappaleiden otsikoista, joista nykyisen palan koodi peritään (katso esittelypala viittauksia). Jos vektori on kääritty sisäänminä ()
ja palavaihtoehtoopts.label
ei ole asetettu, se tarkoittaa, että currentchunk perii myös siihen viitattujen kappaleiden lohkovaihtoehdot (koodin lisäksi). Katso lohkovaihtoehtoopts.label
saadaksesi lisätietoja lohkovaihtoehtojen perimisestä.
Lapsen asiakirjat
lapsi
:(TYHJÄ
; merkki) Neulottavien ja pääasiakirjaan syöttävien aliasiakirjojen polkujen merkkivektori.
Kielimoottorit
moottori
:("R"
; merkki) Koodikappaleen kielinimi. Mahdolliset arvot löytyvätnimet(neulo::neulo_moottorit$get())
, esim.,python
,sql
,julia
,lyödä
, jac
jne. Objektiknitr::knit_engines
voidaan käyttää moottoreiden määrittämiseen muille kielille. Thedemosivusisältää esimerkkejä eri moottoreista.engine.path
:(TYHJÄ
; merkki) Polku tiedoston suoritettavaan tiedostoonmoottori
. Tämä vaihtoehto mahdollistaa vaihtoehtoisten suoritettavien tiedostojen käyttämisen järjestelmässäsi, esim. oletusarvoapython
voi olla klo/usr/bin/python
, ja voit asettaaengine.path = '~/anaconda/bin/python'
käyttää eri Python-versiota.engine.path
voi olla myös luettelo polkuista, mikä mahdollistaa erilaisten moottoripolkujen asettamisen eri moottoreille, esim.knitr::opts_chunk$set(moottori.polku = lista(python = '~/anaconda/bin/python', ruby = '/usr/local/bin/ruby'))
Listan nimet vastaavat moottoreiden nimiä.
engine.opts
:(TYHJÄ
; merkki) Lisäargumentit välitettiin moottoreille. Osatasolla vaihtoehto voidaan määrittää merkkijonona tai vaihtoehtoluettelona.```{bash, engine.opts='-l'}echo $PATH``````{kissa, engine.opts = list(file = "my_custom.css")}h2 { color: blue;}` ``
Globaalilla tasolla se voisi olla luettelo moottoreiden nimeämistä merkkijonoista. Kuten
engine.path
, tämä on hyödyllinen argumenttien mallintamiseen kauttaknitr::opts_chunk$set()
.knitr::opts_chunk$set(engine.opts = list( perl = '-Mstrict -Mwarnings', bash = '-o errexit'))
Jokainen moottori omaan käyttöönsä
engine.opts
ja määrittää erityiset vaihtoehdot.Tulisi tutustua kunkin moottorin asiakirjoihin. Joitakin esimerkkejä on R Markdown -keittokirjassakissa
moottorijasass
/scss
moottori.
Vaihtoehtomallit
opts.label
:(TYHJÄ
; merkki) Tämä vaihtoehto tarjoaa mekanismin, jolla voit periä osan valinnat jommastakummasta vaihtoehtomallistaknitr::opts_template
(katso?knitr::opts_template
) tai muita koodinpätkiä. Se vaatii tarrojen merkkivektorin. Jokaiselle vektorin tunnisteelleknitryrittää ensin löytää asetettuja lohkovaihtoehtojaknitr::opts_template
tällä tunnisteella ja jos löydät, käytä näitä lohkovaihtoehtoja nykyiseen osaan. Yritä sitten löytää asiakirjasta toinen tällä tunnisteella varustettu koodipala (kutsutaan "viittaukseksi koodikappaleeksi"), ja jos se löytyy, käytä myös sen lohkovaihtoehtoja nykyiseen osaan.Osavaihtoehtojen tärkeysjärjestys on: paikalliset osavaihtoehdot > viitatut koodikappaleasetukset >
knitr::opts_template
>knitr::opts_chunk
.Erityinen arvo
opts.label = TOSI
tarkoittaaopts.label = ref.label
, eli periä kappalevaihtoehdot kappaleista, joihin viittaaref.label
Katso esimerkki #121 tuumaaknitr-esimerkkiarkistoeri käyttötapojen demoilleref.label
jaopts.label
.
Lähdekoodin purkaminen
nurin
:(TOTTA
; looginen) Juoksettaessaneuloa:: nurin()
poimimaan lähdekoodin lähdedokumentista riippumatta siitä, sisällytetäänkö tietty koodipala tai jätetäänkö se pois.
Muut lohkovaihtoehdot
R.optiot
:(TYHJÄ
; lista) Paikalliset R-vaihtoehdot koodikappaleelle. Nämä vaihtoehdot asetetaan tilapäisesti kauttavaihtoehdot ()
ennen koodikappaletta ja palauttaa osan jälkeen.
Pakettivaihtoehdot
Paketin asetuksia voidaan muuttaa objektin avullaknitr::opts_knit(ei pidä sekoittaaknitr::opts_chunk
). Esimerkiksi:
knitr::opts_knit$set(eteneminen = TOSI, monisanainen = TOSI)
Katso?knitr::opts_knit
vaihtoehtoinen lähestymistapa pakettivaihtoehtojen asettamiseen käyttämällä R-perustoimintoavaihtoehdot ()
.
Saatavilla olevat pakettivaihtoehdot ovat seuraavat:
aliaksia
:(TYHJÄ
; merkki) Nimetty merkkivektori, joka määrittää lohkovaihtoehtojen aliaksia, esim.c(h = 'kuvan korkeus', w = 'kuvan leveys')
kertooknitrettä palavaihtoehtoh
todella tarkoittaafig.korkeus
, jaw
on analiasfig.width
. Tätä vaihtoehtoa voidaan käyttää säästämään kirjoitustyötä pitkille vaihtoehtonimille.base.dir
:(TYHJÄ
; merkki) Absoluuttinen hakemisto, jonka alle juonit luodaan.base.url
:(TYHJÄ
; merkki) HTML-sivujen kuvien perus-URL-osoite.yhteensopivuus
:(VÄÄRÄ
; looginen) Määrittää, kirjoitetaanko yhteensopivuustiedosto, joka yhdistää lähtörivien numerot tulorivien numeroihin. Tämä mahdollistaa siirtymisen lähdöstä tuloon, ja voi olla hyödyllistä erityisesti silloin, kun tapahtuu aTeX-virhe. Tämä ominaisuus on tarkoitettu vain.Rnw
asiakirjat ja toteutettu RStudiossa.eval.after
:(c('fig.cap', 'fig.scap', 'fig.alt')
; merkki) Vaihtoehtonimien merkkivektori. Näitä vaihtoehtoja arvioidaanjälkeenpala on arvioitu, ja kaikki muut vaihtoehdot arvioidaan ennen kappaletta. Esimerkiksi vartenfig.cap = paste('p-arvo on', t.test(x)$p.value)
, se arvioidaan palan jälkeen arvon mukaanx
joseval.after = 'fig.cap'
.global.by
:(VÄÄRÄ
; looginen) JosTOTTA
,par()
aiemman koodiosan asetukset säilytetään ja niitä sovelletaan seuraavaan koodipalaan (tämä koskee tietysti vain perus-R-grafiikkaa). Oletuksena,knitravaa uuden graafisen laitteen juonteiden tallentamiseksi ja sulkee sen koodin arvioinnin jälkeen, jotenpar()
asetukset hylätään.otsikko
:(TYHJÄ
; merkki) Tulosteasiakirjaan lisättävä teksti ennen dokumentin alkua (esim\documentclass{artikkeli}
LaTeXissä tai sen jälkeenHTML:ssä). Tämä on hyödyllistä komentojen ja tyylien määrittämisessä LaTeX:n johdanto-osassa tai HTML-otsikossa. Dokumentin alku löytyy kohdassa määriteltyä mallia käyttäen
knitr::knit_patterns$get('document.begin')
. Tämä vaihtoehto on tarkoitettu vain.Rnw
ja.Rhtml
asiakirjoja.etiketti.etuliite
:(c(taulukko = 'välilehti:')
; merkki) Tarrojen etuliite. Tällä hetkellä vain etuliite taulukon tunnisteille, jotka on luotuneuloa::kaapeli()
tuettu.lateksi.vaihtoehdot.väri
,latex.options.graphicx
(TYHJÄ
): LaTeX-pakettien asetuksetvärijagraphicx, vastaavasti. Nämä vaihtoehdot ovat vain.Rnw
asiakirjoja.lateksi.tilde
(TYHJÄ
; merkki): LaTeX-komentomerkkijono tilde-merkille syntaksissa korostetun kappaleen tulosteen.Rnw
asiakirjat (katsonumero 1992esimerkeiksi).out.formaatissa
:(TYHJÄ
; merkki) Mahdolliset arvot ovatlateksi
,kutoa
,html
,alas
, jajekyll
. Se määritetään automaattisesti syöttötiedoston perusteella ja tämä vaihtoehto vaikuttaa asetettaviin koukkuihin (katso?knitr::render_latex
esimerkiksi). Huomaa, että tämä vaihtoehto on asetettavaennenneuloa::neuloa()
toimii (se ei toimi, jos asetat sen asiakirjan sisään).edistystä
:(TOTTA
; looginen) Näytetäänkö edistymispalkki käynnissäneuloa::neuloa()
.root.dir
:(TYHJÄ
; merkki) juurihakemisto koodipaloja arvioitaessa. JosTYHJÄ
, käytetään syöttöasiakirjan hakemistoa.itsenäinen
:(TOTTA
; looginen) Onko tulostedokumentin oltava itsenäinen (TeX-tyylit kirjoitetaan.tex
asiakirja ja CSS-tyylejä, jotka kirjoitetaan.html
asiakirja). Tämä vaihtoehto koskee vain.Rnw
ja.Rhtml
asiakirjoja.unnamed.chunk.label
:(nimetön pala
; merkki) Tunnisteen etuliite forunnamed chunks.upload.fun
:(identiteetti
; function) Funktio, joka valitsee tiedostopolun, käsittelee tiedoston ja palauttaa merkkijonon, kun tulostemuoto on HTML tai Markdown. Tyypillisesti se on toiminto, jolla ladataan kuva ja palautetaan linkki kuvaan, esim.knitr::opts_knit$set(upload.fun = knitr::imgur_upload)
voi ladata tiedostonhttp://imgur.com(katso?knitr::imgur_upload
).monisanainen
:(VÄÄRÄ
; looginen) Näytetäänkö monisanaiset tiedot (esim. R-koodi jokaisessa osassa ja viestilokeissa) vai näytetäänkö vain kappaleen tunnisteet ja asetukset.
Yleiset R-vaihtoehdot
Globaalit R-asetukset on asetettuvaihtoehdot ()
pohjassa R. Alla on luettelo vaihtoehdoista, jotka vaikuttavat järjestelmän toimintaanknitr:
knitr.bib.etuliite
:(R-
; merkki) Etuliite kirjallisuusmerkintöjen avaimille, jotka on luonutneuloa::write_bib()
.neuloa.lapsi.varoitus
:(TOTTA
; looginen) Kun koodikappale käyttäälapsi
vaihtoehto sisällyttää alatason asiakirjat, varoitus annetaan, jos koodilohko ei ole tyhjä (koska koodi ohitetaan). Tämä vaihtoehto voidaan määrittääVÄÄRÄ
vaimentaaksesi varoituksen.knitr.digits.signif
:(VÄÄRÄ
; looginen) Kun muotoillaan numeerisia arvoja rivin sisäisistä R-lausekkeista, käytetäänkömuoto()
(TOTTA
) taipyöristää()
(VÄÄRÄ
). Edellinen tarkoittaa globaalia vaihtoehtoanumeroita
(asetettu kauttavaihtoehto (numerot =)
) määrittää merkitsevien numeroiden määrän. Jälkimmäinen tarkoittaa vaihtoehtoanumeroita
määrittää desimaalien määrän.knitr.duplicate.label
:(TYHJÄ
) Jos asetettu"sallia"
, päällekkäiset osatunnisteet sallitaan samassa asiakirjassa.knitr.include.graphics.ext
:(VÄÄRÄ
; looginen) Määrittää, säilytetäänkö tiedostopääte, kun sisällytetään tonttitiedoston polku\includegraphics{}
LaTeX-lähtöön.neuloa.edistyminen.yksinkertainen
:(TYHJÄ
; looginen) Näytetäänkö (teksti)palkki edistymistulosteessa.neuloa.edistyminen.hauskaa
:(neuloa:::txt_pb
; funktio) Muodon funktiofunktio (yhteensä, tunnisteet) {}
. Tämän funktion tulee ottaa argumenttejakaikki yhteensä
(palojen kokonaismäärä) jatarrat
(osamerkkien vektori), luo edistymispalkki ja palauta luettelo kahdesta menetelmästä:lista(päivitys = toiminto(i) {}, valmis = toiminto() {})
. Thepäivittää()
menetelmä ottaai
(nykyisen palan indeksi) syötteenä ja päivittää edistymispalkin. Thetehty()
menetelmä sulkee edistymispalkin.Alla on esimerkkicliedistymispalkki:
function(yhteensä, tunnisteet) { id = cli::cli_progress_bar( yhteensä = yhteensä, .auto_close = EPÄTOSI ) list( update = function(i) { cli::cli_progress_update(id = id) }, done = function() { cli ::cli_process_done(id) } )}
Ja alla on esimerkki Windowsin edistymispalkin käytöstä (joka toimii tietysti vain Windowsissa):
function(yhteensä, etiketit) { pb = winProgressBar("Neulominen...", max = yhteensä) list( update = function(i) { setWinProgressBar(pb, i, label = labels[i]) }, done = function( ) { sulje(pb) } )}
knitr.progress.linenums
:(VÄÄRÄ
; looginen) Näytetäänkö rivinumerot edistymispalkissa. Oletusarvoisesti vain osatunnisteet näytetään.knitr.progress.output
:(""
; merkki tai yhteys) Oletustekstin edistymispalkkiinknitr, tätä vaihtoehtoa voidaan käyttää etenemispalkin tulostavoitteen määrittämiseen. Oletuksena edistyminen kirjoitetaanstdout()
. Jos haluat käyttäästderr
sen sijaan voit asettaa tämän vaihtoehdonstderr()
.knitr.purl.inline
:(VÄÄRÄ
; looginen) Sisällytetäänkö rivin R-koodi sisäänneuloa:: nurin()
ulostulo.knitr.svg.object
:(VÄÄRÄ
; looginen) JosTOTTA
,svg
plotit upotetaan raakana XML:nä () erillisessä HTML-tulosteessa, ja ne sisällytetään siihen
tagit, jos HTML-tuloste ei ole itsenäinen. JosVÄÄRÄ
,tunnistetta käytetään.