Guía del Google I Estilo

Guía del Google I Estilo

R es un lenguaje de programación de alto nivel utilizado principalmente para computación y gráficos estadísticos. El objetivo de la Guía de Estilo R programación es hacer que nuestro código R más fácil de leer, compartir y verificar. Las siguientes reglas fueron diseñadas en colaboración con toda la comunidad de R usuario en Google.

• Resumen: R Reglas Estilo

1. Nombres de archivo : fin en .R

2. Identificadores : variable.name , NombreFunción , kConstantName

3. Longitud de la línea : 80 caracteres como máximo

4. Sangría : dos espacios, sin pestañas

5. Espaciado

6. Curly Tirantes : primero en la misma línea, la última en la propia línea de

7. Asignación : usar <- , no =

8. Punto y coma : No utilice los

9. Disposición general y pedidos

10. Comentando Directrices : todos los comentarios comienzan con # seguido de un espacio; comentarios en línea necesitan dos espacios antes de la #

11. Definiciones de función y Llamadas

12. Documentación de las funciones

13. Ejemplo de la función

14. TODO Estilo : TODO (nombre de usuario)

• Resumen: R Reglas del idioma

1. adjuntar : evitar su uso

2. Funciones : los errores deben ser levantadas utilizando stop ()

3. Objetos y Métodos : evitar los objetos y métodos cuando sea posible S4; Nunca mezcle S3 y S4

1. Notación y Naming

o Nombres de archivo

Nombre de los archivos terminan en .R y, por supuesto, ser significativa.

BUENO: predict_ad_revenue.R

BAD: foo.R

o Identificadores

No use guiones bajos ( _ ) o guiones ( - ) en los identificadores. Identificadores deben ser nombradas de acuerdo a los siguientes convenios. Los nombres de variables deben tener todas las letras y palabras separadas con puntos minúsculas ( . ); nombres de las funciones tienen letras mayúsculas iniciales y sin puntos (CapWords); constantes se nombran como funciones, pero con una inicial k .

 variable.name

BUENO: avg.clicks

BAD: avg_Clicks , avgClicks

 NombreFunción

BUENO: CalculateAvgClicks

BAD: calculate_avg_clicks , calculateAvgClicks

. Haga nombres de función verbos Excepción: Cuando se crea un objeto clasificada, el nombre de la función (constructor) y la clase deben coincidir (por ejemplo, lm).

 kConstantName

2. Sintaxis

o Longitud de la línea

La longitud máxima de la línea es de 80 caracteres.

o Sangría

Cuando sangría su código, use dos espacios. Nunca utilice pestañas o mezclar las fichas y espacios. Excepción: Cuando se produce un salto de línea dentro de paréntesis, alinee la línea envuelto con el primer carácter dentro del paréntesis.

o Espaciado

Espacios Colocar alrededor de todos los operadores binarios ( = , + , - , <- , etc). Excepción: Los espacios alrededor = 's son opcionales al pasar parámetros en una llamada a la función.

No coloque un espacio antes de una coma, pero siempre coloque uno después de una coma. BUENO:

tabPrior <- mesa (df [df $ daysFromOpt <0, "campaignId"])

Total <- sum (x [, 1])

total de <- suma (x [1,])

BAD:

tabPrior <- mesa (df [df $ daysFromOpt <0, "campaignId"]) # Necesidades espacios alrededor de '<'

tabPrior <- mesa (df [df $ daysFromOpt <0, "campaignId"]) # necesita un espacio después de la coma

tabPrior <- mesa (df [df $ daysFromOpt <0, "campaignId"]) # necesita un espacio antes de <-

tabPrior <-table (df [df $ daysFromOpt <0, "campaignId"]) # Necesidades espacios alrededor <-

Total <- sum (x [, 1]) # necesita un espacio después de la coma

Total <- sum (x [, 1]) # necesita un espacio después de la coma, no antes

Ponga un espacio antes paréntesis izquierdo, excepto en una llamada de función.

BUENO: if (debug)

BAD: if (debug)

Espaciado extra (es decir, más de un espacio en una fila) está bien si mejora la alineación de los signos de igual o flechas ( <- ).

plot (x = xCoord,

y = Datamat [, makeColName (métricas, ptiles [1], "roiOpt")],

ylim = ylim,

XLab = "fechas",

ylab = métrica,

main = (pasta (métrica, "por 3 muestras", sep = "")))

No ponga espacios alrededor de código entre paréntesis o corchetes. Excepción: Coloque siempre un espacio después de una coma.

BUENO:

if (debug)

x [1,]

BAD:

if (depuración) # No hay espacios alrededor de depuración

x [1,] # necesita un espacio después de la coma

o Curly Tirantes

Una llave de apertura nunca debe ir en su propia línea; una llave de cierre debe ir siempre en su propia línea. Se puede omitir las llaves cuando un bloque se compone de una sola declaración; sin embargo, debe constantemente ya sea usar o no usar llaves para bloques de instrucciones individuales.

if (is.null (ylim)) {

ylim <- c (0, 0.06)

}

xor (pero no ambos)

if (is.null (ylim))

ylim <- c (0, 0.06)

Comience siempre el cuerpo de un bloque en una línea nueva.

BAD: ylim <if (is.null (ylim)) - c (0, 0,06) si (is.null (ylim)) {ylim <- c (0, 0,06)}

o Asignación

Utilice <- , no = , para la asignación.

BUENO: x <- 5

BAD: x = 5

o Punto y coma

No termine sus líneas con punto y coma o utilice punto y coma para poner más de un comando en la misma línea. (Punto y coma no son necesarios, y se omiten para mantener la coherencia con otras guías de estilo de Google.)

3. Organización

o Disposición general y pedidos

Si todo el mundo utiliza el mismo orden en general, vamos a ser capaces de leer y entender los scripts del otro más rápido y más fácilmente.

1. Declaración de nota de copyright,

...